noid-rails 3.0.0

data/spec/support/shared_examples/minter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+shared_examples 'a minter' do
+  describe '#mint' do
+    subject { minter.mint }
+
+    it { is_expected.not_to be_empty }
+
+    it 'does not mint the same ID twice in a row' do
+      expect(subject).not_to eq described_class.new.mint
+    end
+
+    it 'is valid' do
+      expect(minter.valid?(subject)).to be true
+      expect(described_class.new.valid?(subject)).to be true
+    end
+
+    context 'with a different template' do
+      it 'is invalid' do
+        expect(described_class.new('.reedddk').valid?(subject)).to be false
+      end
+    end
+  end
+
+  context 'when the id already exists' do
+    let(:existing_id) { 'ef12ef12f' }
+    let(:unique_id) { 'bb22bb22b' }
+
+    before do
+      expect(subject).to receive(:next_id).and_return(existing_id, unique_id)
+      allow(subject).to receive(:identifier_in_use?).with(existing_id).and_return(true)
+      allow(subject).to receive(:identifier_in_use?).with(unique_id).and_return(false)
+    end
+
+    it 'skips the existing id' do
+      expect(subject.mint).to eq unique_id
+    end
+  end
+end

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+class TestAppGenerator < Rails::Generators::Base
+  source_root './spec/test_app_templates'
+
+  # if you need to generate any additional configuration
+  # into the test app, this generator will be run immediately
+  # after setting up the application
+
+  def install_engine
+    generate 'noid:rails:install'
+    rake 'db:migrate'
+  end
+end

data/spec/unit/config_spec.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+RSpec.describe Noid::Rails::Config do
+  subject { described_class.new }
+
+  it { is_expected.to respond_to(:template) }
+  it { is_expected.to respond_to(:statefile) }
+  it { is_expected.to respond_to(:namespace) }
+  it { is_expected.to respond_to(:minter_class) }
+
+  describe '#template' do
+    let(:default) { '.reeddeeddk' }
+
+    it 'has a default' do
+      expect(subject.template).to eq default
+    end
+
+    describe 'overriding' do
+      before { subject.template = custom_template }
+
+      let(:custom_template) { '.dddddd' }
+
+      it 'allows setting a custom template' do
+        expect(subject.template).to eq custom_template
+      end
+    end
+  end
+
+  describe '#minter_class' do
+    let(:default) { Noid::Rails::Minter::File }
+
+    it 'has a default' do
+      expect(subject.minter_class).to eq default
+    end
+
+    context 'when overridden' do
+      before { subject.minter_class = different_minter }
+      let(:different_minter) { Noid::Rails::Minter::File }
+
+      it 'uses the different minter' do
+        expect(subject.minter_class).to eq different_minter
+      end
+    end
+  end
+end

data/spec/unit/db_minter_spec.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+RSpec.describe Noid::Rails::Minter::Db do
+  include MinterStateHelper
+
+  after { reset_minter_state_table }
+  subject(:db_minter) { described_class.new }
+
+  before do
+    reset_minter_state_table
+  end
+
+  it_behaves_like 'a minter' do
+    let(:minter) { db_minter }
+  end
+
+  describe '#initialize' do
+    it 'raises on bad templates' do
+      expect { described_class.new('reeddeeddk') }.to raise_error(Noid::TemplateError)
+      expect { described_class.new('')           }.to raise_error(Noid::TemplateError)
+    end
+    it 'returns object w/ default template' do
+      expect(db_minter).to be_instance_of described_class
+      expect(db_minter).to be_a Noid::Minter
+      expect(db_minter.template).to be_instance_of Noid::Template
+      expect(db_minter.template.to_s).to eq Noid::Rails.config.template
+    end
+    context 'with a user provided template' do
+      let(:db_minter) { described_class.new('.reedddk') }
+
+      it 'accepts valid template arg' do
+        expect(db_minter).to be_instance_of described_class
+        expect(db_minter).to be_a Noid::Minter
+        expect(db_minter.template).to be_instance_of Noid::Template
+        expect(db_minter.template.to_s).to eq '.reedddk'
+      end
+    end
+  end
+
+  describe '#read' do
+    subject { db_minter.read }
+
+    context 'when the database has been initialized' do
+      it 'has the expected namespace and template' do
+        expect(subject).to include(namespace: Noid::Rails.config.namespace,
+                                   template: Noid::Rails.config.template)
+      end
+    end
+
+    context 'when the database has not been initialized' do
+      before do
+        MinterState.destroy_all
+      end
+      it 'has the expected namespace and template' do
+        expect(subject).to include(namespace: Noid::Rails.config.namespace,
+                                   template: Noid::Rails.config.template)
+      end
+    end
+  end
+
+  describe '#write!' do
+    let(:starting_state) { db_minter.read }
+    let(:minter) { Noid::Minter.new(starting_state) }
+
+    before { minter.mint }
+
+    it 'changes the state of the minter' do
+      expect { db_minter.write!(minter) }
+        .to change { db_minter.read[:seq] }
+        .from(starting_state[:seq]).to(minter.seq)
+        .and change { db_minter.read[:counters] }
+        .from(starting_state[:counters]).to(minter.counters)
+        .and change { db_minter.read[:rand] }
+        .from(starting_state[:rand]).to(Marshal.dump(minter.instance_variable_get(:@rand)))
+    end
+  end
+
+  describe '#next_id' do
+    let(:stub_minter) { described_class.new }
+    let(:locked) { MinterState }
+
+    it 'locks DB row and does not query twice' do
+      expect(MinterState).to receive(:lock).and_return(locked).once
+      expect(locked).to receive(:find_by!).once.and_return(MinterState.first)
+      stub_minter.send(:next_id)
+    end
+  end
+end

data/spec/unit/file_minter_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+RSpec.describe Noid::Rails::Minter::File do
+  it { is_expected.to respond_to(:mint) }
+
+  it 'has a default statefile' do
+    expect(subject.statefile).to eq Noid::Rails.config.statefile
+  end
+  it 'has a default template' do
+    expect(subject.template.to_s).to eq Noid::Rails.config.template
+  end
+
+  it_behaves_like 'a minter' do
+    let(:minter) { described_class.new }
+  end
+
+  describe '#initialize' do
+    let(:template) { '.rededk' }
+    let(:statefile) { '/tmp/foobar' }
+
+    subject { described_class.new(template, statefile) }
+
+    it 'respects the custom template' do
+      expect(subject.template.to_s).to eq template
+    end
+    it 'respects the custom statefile' do
+      expect(subject.statefile).to eq statefile
+    end
+  end
+
+  describe '#read' do
+    it 'returns a hash' do
+      expect(subject.read).to be_a(Hash)
+    end
+    it 'has the expected template' do
+      expect(subject.read[:template]).to eq Noid::Rails.config.template
+    end
+  end
+
+  describe '#write!' do
+    let(:starting_state) { subject.read }
+    let(:minter) { Noid::Minter.new(starting_state) }
+
+    before { minter.mint }
+    it 'changes the state of the minter' do
+      expect { subject.write!(minter) }.to change { subject.read[:seq] }
+        .from(starting_state[:seq]).to(minter.seq)
+        .and change { subject.read[:rand] }
+        .from(starting_state[:rand]).to(Marshal.dump(minter.instance_variable_get(:@rand)))
+        .and change { subject.read[:counters] }
+        .to(minter.counters)
+    end
+  end
+end

data/spec/unit/noid_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+RSpec.describe Noid::Rails do
+  describe '#configure' do
+    it { is_expected.to respond_to(:configure) }
+  end
+
+  describe '#config' do
+    it 'returns a config object' do
+      expect(subject.config).to be_instance_of Noid::Rails::Config
+    end
+  end
+
+  describe '#treeify' do
+    subject { described_class.treeify(id) }
+
+    let(:id) { 'abc123def45' }
+
+    it { is_expected.to eq 'ab/c1/23/de/abc123def45' }
+
+    context 'with a seven-digit identifier' do
+      let(:id) { 'abc123z' }
+
+      it { is_expected.to eq 'ab/c1/23/z/abc123z' }
+    end
+
+    context 'with an empty string' do
+      let(:id) { '' }
+
+      it 'raises ArgumentError' do
+        expect { subject }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'with a nil' do
+      let(:id) { nil }
+
+      it 'raises ArgumentError' do
+        expect { subject }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/unit/rspec_spec.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'noid/rails/rspec'
+
+RSpec.describe Noid::Rails::RSpec do
+  include described_class
+
+  let(:configured_minter) { @configured_minter }
+  let(:var_name)          { :@original_minter }
+
+  before do
+    @configured_minter = Class.new(Noid::Rails::Minter::Base)
+    @reset_minter      = Noid::Rails.config.minter_class
+
+    Noid::Rails.configure do |noid_config|
+      noid_config.minter_class = @configured_minter
+    end
+  end
+
+  after do
+    Noid::Rails.configure do |noid_config|
+      noid_config.minter_class = @reset_minter
+    end
+  end
+
+  describe '#disable_production_minter!' do
+    it 'changes the configured minter' do
+      expect { disable_production_minter! }
+        .to change { Noid::Rails.config.minter_class }
+        .from(configured_minter)
+        .to described_class::DEFAULT_TEST_MINTER
+    end
+
+    it 'accepts custom test minter at call time' do
+      my_minter = Class.new(Noid::Rails::Minter::Base)
+
+      expect { disable_production_minter!(test_minter: my_minter) }
+        .to change { Noid::Rails.config.minter_class }
+        .from(configured_minter)
+        .to my_minter
+    end
+
+    it 'does not overwrite stored minter on second call' do
+      disable_production_minter!
+
+      expect { disable_production_minter! }.not_to change { described_class.instance_variable_get(var_name) }
+    end
+
+    it 'still reenables after second call' do
+      2.times { disable_production_minter! }
+      expect { enable_production_minter! }
+        .to change { Noid::Rails.config.minter_class }
+        .from(described_class::DEFAULT_TEST_MINTER).to configured_minter
+    end
+
+    it 'disables after reenable' do
+      disable_production_minter!
+      enable_production_minter!
+      expect { disable_production_minter! }
+        .to change { Noid::Rails.config.minter_class }
+        .from(configured_minter).to described_class::DEFAULT_TEST_MINTER
+    end
+  end
+
+  describe '#enable_production_minter!' do
+    it 'does nothing when already enabled' do
+      expect { enable_production_minter! }
+        .not_to change { Noid::Rails.config.minter_class }
+    end
+
+    context 'with minter disabled' do
+      before { disable_production_minter! }
+
+      it 'reenables the originally configured minter' do
+        expect { enable_production_minter! }
+          .to change { Noid::Rails.config.minter_class }
+          .from(described_class::DEFAULT_TEST_MINTER)
+          .to configured_minter
+      end
+
+      it 'enables after re-disable' do
+        enable_production_minter!
+        disable_production_minter!
+        expect { enable_production_minter! }
+          .to change { Noid::Rails.config.minter_class }
+          .from(described_class::DEFAULT_TEST_MINTER).to configured_minter
+      end
+    end
+  end
+end

data/spec/unit/service_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+RSpec.describe Noid::Rails::Service do
+  describe 'public API' do
+    it { is_expected.to respond_to(:valid?) }
+    it { is_expected.to respond_to(:mint) }
+  end
+
+  it 'has a default minter' do
+    expect(subject.minter).to be_instance_of Noid::Rails::Minter::File
+  end
+
+  context 'with a custom minter' do
+    let(:minter) { double('minter') }
+    let(:identifier) { 'abc123' }
+    let(:new_service) { described_class.new(minter) }
+
+    it 'allows injecting a custom minter' do
+      expect(new_service.minter).to eq minter
+    end
+
+    it 'delegates validity checking to the minter' do
+      expect(minter).to receive(:valid?).with(identifier).once
+      new_service.valid? identifier
+    end
+
+    it 'delegates minting to the minter' do
+      expect(minter).to receive(:mint).once
+      new_service.mint
+    end
+  end
+end

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: noid-rails
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Michael J. Giarlo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: noid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: engine_cart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Noid identifier services for Rails-based applications.
+email:
+- leftwing@alumni.rutgers.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/models/minter_state.rb
+- db/migrate/20160610010003_create_minter_states.rb
+- db/migrate/20161021203429_rename_minter_state_random_to_rand.rb
+- lib/generators/noid/rails/install_generator.rb
+- lib/generators/noid/rails/seed_generator.rb
+- lib/noid-rails.rb
+- lib/noid/rails/config.rb
+- lib/noid/rails/engine.rb
+- lib/noid/rails/minter.rb
+- lib/noid/rails/minter/base.rb
+- lib/noid/rails/minter/db.rb
+- lib/noid/rails/minter/file.rb
+- lib/noid/rails/rspec.rb
+- lib/noid/rails/service.rb
+- lib/noid/rails/version.rb
+- lib/tasks/noid_tasks.rake
+- noid-rails.gemspec
+- spec/models/minter_state_spec.rb
+- spec/spec_helper.rb
+- spec/support/minterstate_table.rb
+- spec/support/shared_examples/minter.rb
+- spec/test_app_templates/lib/generators/test_app_generator.rb
+- spec/unit/config_spec.rb
+- spec/unit/db_minter_spec.rb
+- spec/unit/file_minter_spec.rb
+- spec/unit/noid_spec.rb
+- spec/unit/rspec_spec.rb
+- spec/unit/service_spec.rb
+homepage: https://github.com/samvera/noid-rails
+licenses:
+- Apache2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.1
+signing_key: 
+specification_version: 4
+summary: Noid identifier services for Rails-based applications
+test_files:
+- spec/models/minter_state_spec.rb
+- spec/spec_helper.rb
+- spec/support/minterstate_table.rb
+- spec/support/shared_examples/minter.rb
+- spec/test_app_templates/lib/generators/test_app_generator.rb
+- spec/unit/config_spec.rb
+- spec/unit/db_minter_spec.rb
+- spec/unit/file_minter_spec.rb
+- spec/unit/noid_spec.rb
+- spec/unit/rspec_spec.rb
+- spec/unit/service_spec.rb