Incorporated Rubocop changes. Added .rubocopy.yml and updated README.

Signed-off-by: Azeem Sajid <[email protected]>

Author: iamazeem

.rubocop.yml

@@ -0,0 +1,33 @@
+AllCops:
+  NewCops: disable
+  Include:
+    - '**/*.rb'
+    - '**/*.arb'
+    - '**/*.gemfile'
+    - '**/*.gemspec'
+    - '**/*.rake'
+    - '**/.simplecov'
+    - '**/Gemfile'
+    - '**/Guardfile'
+    - '**/Rakefile'
+  Exclude:
+    - 'docs/**/*'
+    - 'tmp/**/*'
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false

Gemfile

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 source 'http://rubygems.org'
 
 # Use dependencies from .gemspec

Guardfile

@@ -1,8 +1,10 @@
+# frozen-string-literal: true
+
 # Guardfile for tests
 # More info at https://github.com/guard/guard#readme
 
 guard :test do
-  watch(%r{^lib/(.+)\.so$})     { "test" }
-  watch('test/test_helper.rb')  { "test" }
+  watch(%r{^lib/(.+)\.so$})     { 'test' }
+  watch('test/test_helper.rb')  { 'test' }
   watch(%r{^test/.+_test\.rb$})
 end

README.md

@@ -1,5 +1,4 @@
-taglib-ruby
-===========
+# taglib-ruby
 
 Ruby interface for the [TagLib C++ library][taglib], for reading and
 writing meta-data (tags) of many audio formats.
@@ -8,7 +7,7 @@ In contrast to other libraries, this one wraps the full C++ API, not
 only the minimal C API. This means that all tag data can be accessed,
 e.g. cover art of ID3v2 or custom fields of Ogg Vorbis comments.
 
-taglib-ruby currently supports the following:
+`taglib-ruby` currently supports the following:
 
 * Reading/writing common tag data of all formats that TagLib supports
 * Reading/writing ID3v1 and ID3v2 including ID3v2.4 and Unicode
@@ -21,11 +20,10 @@ Contributions for more coverage of the library are very welcome.
 [![Gem version][gem-img]][gem-link]
 [![ci](https://github.com/robinst/taglib-ruby/workflows/ci/badge.svg)](https://github.com/robinst/taglib-ruby/actions?query=workflow%3Aci)
 
-Installation
-------------
+## Installation
 
-Before you install the gem, make sure to have [taglib 1.11.1 or higher][taglib] installed
-with header files (and a C++ compiler of course):
+Before you install the gem, make sure to have [taglib 1.11.1 or higher][taglib]
+installed with header files (and a C++ compiler of course):
 
 * Debian/Ubuntu: `sudo apt-get install libtag1-dev`
 * Fedora/RHEL: `sudo dnf install taglib-devel`
@@ -34,107 +32,138 @@ with header files (and a C++ compiler of course):
 
 Then do:
 
-    gem install taglib-ruby
+```shell
+gem install taglib-ruby
+```
 
 ### OS X C++ compiler override
 
 Not all versions of TagLib get along with `clang++`, the default C++ compiler
 on OS X. To compile taglib-ruby's C++ extensions with a different compiler
 during installation, set the `TAGLIB_RUBY_CXX` environment variable.
 
-    TAGLIB_RUBY_CXX=g++-4.2 gem install taglib-ruby
+```shell
+TAGLIB_RUBY_CXX=g++-4.2 gem install taglib-ruby
+```
 
-Usage
------
+## Usage
 
 Complete API documentation can be found on
 [rubydoc.info](http://rubydoc.info/gems/taglib-ruby/frames).
 
-Begin with the {TagLib} namespace.
+Begin with the `TagLib` namespace.
 
-Release Notes
--------------
+## Release Notes
 
-See {file:CHANGELOG.md}.
+See [CHANGELOG.md](CHANGELOG.md).
 
-Contributing
-------------
+## Contributing
 
 ### Dependencies
 
 Fedora:
 
-    sudo dnf install taglib-devel ruby-devel gcc-c++ redhat-rpm-config swig
+```shell
+sudo dnf install taglib-devel ruby-devel gcc-c++ redhat-rpm-config swig
+```
 
 ### Building
 
 Install dependencies (uses bundler, install it via `gem install bundler`
 if you don't have it):
 
-    bundle install
+```shell
+bundle install
+```
 
-Regenerate SWIG wrappers if you made changes in `.i` files (use version 3.0.7 of SWIG - 3.0.8 through 3.0.12 will not work):
+Regenerate SWIG wrappers if you made changes in `.i` files (use version 3.0.7 of
+SWIG - 3.0.8 through 3.0.12 will not work):
 
-    rake swig
+```shell
+rake swig
+```
 
 Force regeneration of all SWIG wrappers:
 
-    touch ext/*/*.i
-    rake swig
+```shell
+touch ext/*/*.i
+rake swig
+```
 
 Compile extensions:
 
-    rake clean compile
+```shell
+rake clean compile
+```
 
 Run tests:
 
-    rake test
+```shell
+rake test
+```
 
 Run irb with library:
 
-    irb -Ilib -rtaglib
+```shell
+irb -Ilib -rtaglib
+```
 
 Build and install gem into system gems:
 
-    rake install
+```shell
+rake install
+```
 
 Build a specific version of Taglib:
 
-    PLATFORM=x86_64-linux TAGLIB_VERSION=1.11.1 rake vendor
+```shell
+PLATFORM=x86_64-linux TAGLIB_VERSION=1.11.1 rake vendor
+```
 
-The above command will automatically download Taglib 1.11.1, build it and install it in `tmp/x86_64-linux/taglib-1.11.1`.
+The above command will automatically download Taglib 1.11.1, build it and
+install it in `tmp/x86_64-linux/taglib-1.11.1`.
 
-The `swig` and `compile` tasks can then be executed against that specific version of Taglib by setting the `TAGLIB_DIR` environment variable to `$PWD/tmp/x86_64-linux/taglib-1.11.1` (it is assumed that taglib headers are located at `$TAGLIB_DIR/include` and taglib libraries at `$TAGLIB_DIR/lib`).
+The `swig` and `compile` tasks can then be executed against that specific
+version of Taglib by setting the `TAGLIB_DIR` environment variable to
+`$PWD/tmp/x86_64-linux/taglib-1.11.1` (it is assumed that taglib headers are
+located at `$TAGLIB_DIR/include` and taglib libraries at `$TAGLIB_DIR/lib`).
 
-The `test` task can then be run for that version of Taglib by adding `$PWD/tmp/x86_64-linux/taglib-1.11.1/lib` to the `LD_LIBRARY_PATH` environment variable.
+The `test` task can then be run for that version of Taglib by adding
+`$PWD/tmp/x86_64-linux/taglib-1.11.1/lib` to the `LD_LIBRARY_PATH` environment
+variable.
 
 To do everything in one command:
 
-    PLATFORM=x86_64-linux TAGLIB_VERSION=1.11.1 TAGLIB_DIR=$PWD/tmp/x86_64-linux/taglib-1.11.1 LD_LIBRARY_PATH=$PWD/tmp/x86_64-linux/taglib-1.11.1/lib rake vendor compile test
+```shell
+PLATFORM=x86_64-linux TAGLIB_VERSION=1.11.1 TAGLIB_DIR=$PWD/tmp/x86_64-linux/taglib-1.11.1 LD_LIBRARY_PATH=$PWD/tmp/x86_64-linux/taglib-1.11.1/lib rake vendor compile test
+```
 
 ### Workflow
 
-* Check out the latest main branch to make sure the feature hasn't been
-  implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't
-  requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it
+* Check out the latest `main` branch to make sure the feature hasn't been
+  implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone hasn't already
+  requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch from `main`.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so that I don't break it
   in a future version unintentionally.
+* Run `rubocop` locally to lint your changes and fix the issues. Please refer to
+  [.rubocop.yml](.rubocop.yml) for the list of relaxed rules. Try to keep the
+  liniting offenses to minimum. Preferably, first run `rubocop` on your fork to
+  have a general idea of the existing linting offenses before writing new code.
 * Please try not to mess with the Rakefile, version, or history. If you
   want to have your own version, or is otherwise necessary, that is
   fine, but please isolate to its own commit so I can cherry-pick around
   it.
 
-License
--------
+## License
 
 Copyright (c) 2010-2020 Robin Stocker and others, see Git history.
 
-taglib-ruby is distributed under the MIT License,
-see LICENSE.txt for details.
+`taglib-ruby` is distributed under the MIT License, see
+[LICENSE.txt](LICENSE.txt) for details.
 
 In the binary gem for Windows, a compiled [TagLib][taglib] is bundled as
 a DLL. TagLib is distributed under the GNU Lesser General Public License

Rakefile

@@ -1,11 +1,11 @@
-# encoding: utf-8
+# frozen-string-literal: true
 
 require 'bundler/gem_tasks'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 
@@ -15,7 +15,7 @@ Rake::TestTask.new(:test) do |test|
   test.pattern = 'test/**/*_test.rb'
 end
 
-task :default => [:compile, :test]
+task default: %i[compile test]
 
 require 'yard'
 YARD::Rake::YardocTask.new do |t|
@@ -30,7 +30,7 @@ import 'tasks/ext.rake'
 import 'tasks/gemspec_check.rake'
 
 # When importing swig.rake, the *_wrap.cxx files depend on being generated
-# by Swig. Since the ExtensionTasks depend on the *_wrap.cxx files,
+# by Swig. Since the ExtensionTasks depend on the *_wrap.cxx files,
 # compiling the extensions will trigger Swig, which is not desired as
 # those files have already been generated and there's no reason to make
 # Swig a variable of the CI. The environment variable can be set to

docs/taglib/aiff.rb

@@ -1,6 +1,5 @@
 # @since 0.7.0
 module TagLib::RIFF::AIFF
-
   # The file class for `.aiff` files.
   #
   # @example Reading the title
@@ -58,7 +57,6 @@ def audio_properties
     # @since 1.0.0
     def id3v2_tag?
     end
-
   end
 
   class Properties < TagLib::AudioProperties
@@ -91,5 +89,4 @@ class Properties < TagLib::AudioProperties
     def aiff_c?
     end
   end
-
 end

docs/taglib/base.rb

@@ -45,7 +45,6 @@
 #   tag.title
 #   # => "Title of the song"
 module TagLib
-
   # Major version of TagLib the extensions were compiled against
   # (major.minor.patch). Note that the value is not actually 0, but
   # depends on the version of the installed library.
@@ -88,7 +87,6 @@ module TagLib
   #   end
   #
   class FileRef
-
     # Creates a new file and passes it to the provided block,
     # closing the file automatically at the end of the block.
     #
@@ -165,7 +163,6 @@ def close
 
   # @abstract Base class for files, see subclasses.
   class File
-
     # Save the file and the associated tags.
     #
     # See subclasses, as some provide more control over what is saved.
@@ -241,7 +238,6 @@ def empty?; end
 
   # @abstract Base class for audio properties.
   class AudioProperties
-
     Fast = 0
     Average = 1
     Accurate = 2

docs/taglib/flac.rb

@@ -1,6 +1,5 @@
 # @since 0.5.0
 module TagLib::FLAC
-
   # The file class for `.flac` files.
   #
   # Note that Xiph comments is the primary tagging format for FLAC files. When
@@ -30,7 +29,6 @@ module TagLib::FLAC
   #     file.save
   #   end
   class File < TagLib::File
-
     NoTags      = 0x0000
     XiphComment = 0x0001
     ID3v1       = 0x0002
@@ -183,7 +181,7 @@ class Picture
     BandLogo           = 0x13
     PublisherLogo      = 0x14
 
-    def initialize()
+    def initialize
     end
 
     # Type of the picture, see constants.

docs/taglib/id3v2.rb

@@ -223,7 +223,7 @@ class AttachedPictureFrame < Frame
     BandLogo           = 0x13
     PublisherLogo      = 0x14
 
-    def initialize()
+    def initialize
     end
 
     # @return [String]