metal_archives 0.8.0 → 1.0.0

data/spec/parser_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+RSpec.describe MetalArchives::Parsers::Parser do
+  it 'parses countries' do
+    expect(described_class.parse_country('United States')).to eq ISO3166::Country['US']
+    expect(described_class.parse_country('Germany')).to eq ISO3166::Country['DE']
+    expect(described_class.parse_country('Belgium')).to eq ISO3166::Country['BE']
+  end
+
+  it 'parses genres' do
+    expect(described_class.parse_genre('Death, Power, Black')).to match_array ['Black', 'Death', 'Power']
+    expect(described_class.parse_genre('Death, Power, Black')).to match_array ['Black', 'Death', 'Power']
+    expect(described_class.parse_genre('Death (early), Heavy/Power Metal, Black (later)')).to match_array ['Black', 'Death', 'Heavy', 'Power']
+    expect(described_class.parse_genre('        Death       ,      Power   Metal, Power, Power')).to match_array ['Death', 'Power']
+    expect(described_class.parse_genre('Heavy/Speed Power Metal')).to match_array ['Heavy Power', 'Speed Power']
+    expect(described_class.parse_genre('Traditional Heavy/Power Metal')).to match_array ['Traditional Heavy', 'Traditional Power']
+    expect(described_class.parse_genre('Traditional/Classical Heavy/Power Metal')).to match_array ['Traditional Heavy', 'Traditional Power', 'Classical Heavy', 'Classical Power']
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'factory_girl'
+require 'faker'
+require 'coveralls'
+Coveralls.wear!
+
+require 'metal_archives'
+
+Dir[File.join(__dir__, 'support/**/*.rb')].each { |f| require f }
+Dir[File.join(__dir__, 'factories/**/*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

data/spec/support/factory_girl.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/spec/support/metal_archives.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'metal_archives'
+
+MetalArchives.configure do |c|
+  ## Application identity (required)
+  c.app_name = 'MetalArchivesGemTestSuite'
+  c.app_version = MetalArchives::VERSION
+  c.app_contact = 'user@example.com'
+
+  ## Custom cache size per object class (optional, overrides defaults)
+  # c.cache_size = 100
+
+  ## Metal Archives endpoint (optional, overrides default)
+  c.endpoint = ENV['MA_ENDPOINT'] if ENV['MA_ENDPOINT']
+
+  if ENV['MA_ENDPOINT']
+    puts "Using '#{ENV['MA_ENDPOINT']}' as MA endpoint"
+  end
+
+  ## Custom logger (optional)
+  # c.logger = Logger.new 'metal_archives.log'
+
+  ## Verbose output
+  # c.debug = false
+end

data/spec/utils/collection_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+RSpec.describe MetalArchives::Collection do
+  it 'iterates' do
+    l = lambda do
+      @i ||= 0
+
+      next [] if @i >= 100
+      items = (@i .. (@i + 9)).to_a
+      @i += 10
+
+      items
+    end
+
+    c = MetalArchives::Collection.new l
+
+    i = 0
+    c.each do |item|
+      expect(item).to eq i
+      i += 1
+    end
+  end
+
+  it 'returns' do
+    l = lambda do
+      @i ||= 0
+
+      raise StandardError if @i >= 100
+      items = (@i .. (@i + 9)).to_a
+      @i += 10
+
+      items
+    end
+
+    c = MetalArchives::Collection.new l
+
+    i = 0
+    c.each do |item|
+      break if i == 99
+      expect(item).to eq i
+      i += 1
+    end
+
+    expect(i).to eq 99
+  end
+
+  describe 'empty?' do
+    it 'is not empty' do
+      l = lambda do
+        @i ||= 0
+
+        next [] if @i >= 100
+        items = (@i .. (@i + 9)).to_a
+        @i += 10
+
+        items
+      end
+
+      c = MetalArchives::Collection.new l
+
+      i = 0
+
+      expect(c).not_to be_empty
+    end
+
+    it 'is empty' do
+      c = MetalArchives::Collection.new -> { [] }
+
+      expect(c).to be_empty
+    end
+  end
+end

data/spec/utils/lru_cache_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+RSpec.describe MetalArchives::LRUCache do
+  let(:cache) { MetalArchives::LRUCache.new 3 }
+
+  it 'stores and retrieves objects' do
+    cache[:key] = 'MyString'
+
+    expect(cache[:key]).to eq 'MyString'
+  end
+
+  it 'clears cache' do
+    cache[:key] = 'MyString'
+    cache.clear
+
+    expect(cache[:key]).to be_nil
+  end
+
+  it 'peeks' do
+    expect(cache).not_to include :key
+
+    cache[:key] = 'MyString'
+
+    expect(cache).to include :key
+  end
+
+  it 'deletes' do
+    cache[:key] = 'MyString'
+
+    expect(cache).to include :key
+
+    cache.delete :key
+
+    expect(cache).not_to include :key
+  end
+
+  it 'implements LRU caching' do
+    cache[:a] = 'one'
+    cache[:b] = 'two'
+    cache[:c] = 'three'
+
+    expect(cache.instance_variable_get '@size').to eq 3
+
+    cache[:d] = 'four'
+
+    expect(cache.instance_variable_get '@size').to eq 3
+
+    expect(cache[:b]).to eq 'two'
+    expect(cache[:c]).to eq 'three'
+    expect(cache[:d]).to eq 'four'
+    expect(cache[:a]).to be_nil
+  end
+end

data/spec/utils/nil_date_spec.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+RSpec.describe MetalArchives::NilDate do
+  let(:date) { build :nil_date }
+  let(:date_without_day) { build :nil_date, :day => nil }
+  let(:date_without_month) { build :nil_date, :month => nil }
+
+  it 'has the correct properties' do
+    expect(date).to respond_to :year
+    expect(date).to respond_to :year=
+    expect(date).to respond_to :year?
+
+    expect(date).to respond_to :month
+    expect(date).to respond_to :month=
+    expect(date).to respond_to :month?
+
+    expect(date).to respond_to :day
+    expect(date).to respond_to :day=
+    expect(date).to respond_to :day?
+  end
+
+  it 'returns the correct values' do
+    expect(date.year).not_to be_nil
+    expect(date.year).to be_an Integer
+    expect(date.year?).to be true
+
+    expect(date.month).not_to be_nil
+    expect(date.month).to be_an Integer
+    expect(date.month?).to be true
+
+    expect(date.day).not_to be_nil
+    expect(date.day).to be_an Integer
+    expect(date.day?).to be true
+  end
+
+  it 'does not require a day' do
+    expect(date_without_day.day).to be_nil
+    expect(date_without_day.day?).to be false
+  end
+
+  it 'does not require a month' do
+    expect(date_without_month.month).to be_nil
+    expect(date_without_month.month?).to be false
+  end
+
+  it 'returns a date' do
+    expect(date.date).to be_a Date
+    expect(date.date.year).to eq date.year
+    expect(date.date.month).to eq date.month
+    expect(date.date.day).to eq date.day
+  end
+
+  describe 'parsing' do
+    it 'parses empty dates' do
+      date = described_class.parse ''
+
+      expect(date.year?).to be false
+      expect(date.month?).to be false
+      expect(date.day?).to be false
+    end
+
+    it 'parses dates with year only' do
+      date = described_class.parse '2012'
+
+      expect(date.year?).to be true
+      expect(date.year).to eq 2012
+      expect(date.month?).to be false
+      expect(date.day?).to be false
+    end
+
+    it 'parses parses dates with year and month' do
+      date = described_class.parse '2012-10'
+
+      expect(date.year?).to be true
+      expect(date.year).to eq 2012
+      expect(date.month?).to be true
+      expect(date.month).to eq 10
+      expect(date.day?).to be false
+    end
+
+    it 'parses full dates' do
+      date = described_class.parse '2012-10-02'
+
+      expect(date.year?).to be true
+      expect(date.year).to eq 2012
+      expect(date.month?).to be true
+      expect(date.month).to eq 10
+      expect(date.day?).to be true
+      expect(date.day).to eq 2
+    end
+
+    it 'does not parse on invalid dates' do
+      expect(-> { described_class.parse 'October 2nd, 2012' }).to raise_error MetalArchives::Errors::ArgumentError
+      expect(-> { described_class.parse 'a-b-c' }).to raise_error MetalArchives::Errors::ArgumentError
+      expect(-> { described_class.parse "This isn't a date" }).to raise_error MetalArchives::Errors::ArgumentError
+    end
+  end
+end

data/spec/utils/range_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+RSpec.describe MetalArchives::Range do
+  let(:range) { build :range }
+  let(:begin_range) { build :range, :end => nil }
+  let(:end_range) { build :range, :begin => nil }
+
+  it 'has the correct properties' do
+    expect(range).to respond_to :begin
+    expect(range).to respond_to :begin=
+    expect(range).to respond_to :begin?
+
+    expect(range).to respond_to :end
+    expect(range).to respond_to :end=
+    expect(range).to respond_to :end?
+  end
+
+  it 'returns the correct values' do
+    expect(range.begin).not_to be_nil
+    expect(range.begin).to be_a Date
+    expect(range.begin?).to be true
+
+    expect(range.end).not_to be_nil
+    expect(range.end).to be_a Date
+    expect(range.end?).to be true
+  end
+
+  it 'does not require an end date' do
+    expect(begin_range.end).to be_nil
+    expect(begin_range.end?).to be false
+  end
+
+  it 'does not require a begin date' do
+    expect(end_range.begin).to be_nil
+    expect(end_range.begin?).to be false
+  end
+
+  it 'implements comparable' do
+    range1 = described_class.new 1, 3
+    range1a = described_class.new 1, 3
+    range2 = described_class.new nil, 3
+    range2a = described_class.new nil, 3
+    range3 = described_class.new 1, nil
+    range3a = described_class.new 1, nil
+
+    range4 = described_class.new 1, 4
+    range5 = described_class.new 0, 3
+
+    expect(range1 <=> range1a).to eq 0
+    expect(range2 <=> range2a).to eq 0
+    expect(range3 <=> range3a).to eq 0
+
+    expect(range1 <=> range2).to be_nil
+    expect(range2 <=> range3).to be_nil
+    expect(range3 <=> range1).to be_nil
+
+    expect(range1 <=> range4).to eq -1
+    expect(range1 <=> range5).to eq -1
+    expect(range4 <=> range1).to eq 1
+    expect(range5 <=> range1).to eq 1
+  end
+end