reference_book 0.0.1

data/test/setup/collector_test.rb

@@ -0,0 +1,96 @@
+require 'test_helper'
+
+class CollectorTest < Minitest::Test
+
+  def setup
+    super
+    @collector = ReferenceBook::Setup::Collector.new
+  end
+
+
+
+  def test_undefined_keys
+    assert_nil @collector.foobar
+    assert_empty @collector.to_h
+  end
+
+
+  def test_direct_assignement
+    assert_nil @collector.foo
+    assert_nil @collector.bar
+
+    @collector.foo = "ciao"
+
+    assert_equal "ciao", @collector.foo
+    assert_nil @collector.bar
+  end
+
+
+  def test_hash_assignement
+    assert_nil @collector.foo
+    assert_nil @collector.bar
+
+    @collector[:foo] = "ciao"
+
+    assert_equal "ciao", @collector.foo
+    assert_nil @collector.bar
+  end
+
+
+
+  def test_to_hash
+    assert_empty @collector.to_h
+    assert_equal Hash, @collector.to_h.class
+
+    @collector.foo = "hello"
+    @collector.bar = "ciao"
+
+    refute_empty @collector.to_h
+    assert_equal 2, @collector.to_h.size
+    assert_equal "hello", @collector.to_h[:foo]
+    assert_equal "ciao", @collector.to_h[:bar]
+    assert_nil @collector.to_h[:baz]
+  end
+
+
+  def test_assign_nil
+    assert_nil @collector.foo
+    assert_empty @collector.to_h
+
+    @collector.foo = nil
+
+    assert_nil @collector.foo
+    assert_equal 1, @collector.to_h.size
+    assert_includes @collector.to_h.keys, :foo
+  end
+
+
+
+  def test_set_title_direct
+    assert_raises ReferenceBook::BookDefinitionError do
+      @collector.title = 'anything'
+    end
+  end
+
+
+  def test_set_library_key_direct
+    assert_raises ReferenceBook::BookDefinitionError do
+      @collector.library_key = 'anything'
+    end
+  end
+
+
+  def test_set_title_hash
+    assert_raises ReferenceBook::BookDefinitionError do
+      @collector[:title] = 'anything'
+    end
+  end
+
+
+  def test_set_library_key_hash
+    assert_raises ReferenceBook::BookDefinitionError do
+      @collector[:library_key] = 'anything'
+    end
+  end
+
+end

data/test/setup/locked_book_spec_test.rb

@@ -0,0 +1,117 @@
+require 'test_helper'
+
+class LockedBookSpecTest < Minitest::Test
+
+  
+  def test_constructor
+    result = ReferenceBook::Setup::LockedBookSpec.new([:one])
+    assert result
+    assert_equal ReferenceBook::Setup::LockedBookSpec, result.class
+
+    assert_raises ReferenceBook::LockedBookSpecError do
+      ReferenceBook::Setup::LockedBookSpec.new([])
+    end
+
+    assert_raises ArgumentError do
+      ReferenceBook::Setup::LockedBookSpec.new
+    end
+  end
+
+
+
+  def test_verify_keys_pass
+    spec = make_locked_spec
+
+    assert spec.verify_keys!([:foo, :bar, :baz])
+    assert spec.verify_keys!([:bar, :baz, :foo])
+  end
+
+
+
+  def test_verify_keys_fail_missing
+    spec = make_locked_spec
+
+    error_1 = assert_raises ReferenceBook::BookDefinitionError do
+      spec.verify_keys!([:foo, :bar])
+    end
+
+    reported_missing = extract_missing_keys(error_1.message)
+    assert_equal reported_missing.sort, %w(baz)
+
+    error_2 = assert_raises ReferenceBook::BookDefinitionError do
+      spec.verify_keys!([])
+    end
+
+    reported_missing = extract_missing_keys(error_2.message)
+    assert_equal reported_missing.sort, %w(bar baz foo)
+  end
+
+
+
+  def test_verify_keys_fail_unexpected
+    spec = make_locked_spec
+
+    error_1 = assert_raises ReferenceBook::BookDefinitionError do
+      spec.verify_keys!([:foo, :bar, :baz, :hello])
+    end
+
+    reported_unexpected = extract_unexpected_keys(error_1.message)
+    assert_equal reported_unexpected.sort, %w(hello)
+
+    error_2 = assert_raises ReferenceBook::BookDefinitionError do
+      spec.verify_keys!([:foo, :baz, :one, :two, :bar])
+    end
+
+    reported_unexpected = extract_unexpected_keys(error_2.message)
+    assert_equal reported_unexpected.sort, %w(one two)
+  end
+
+
+
+  def test_verify_keys_fail_missing_and_unexpected
+    spec = make_locked_spec
+
+    error_1 = assert_raises ReferenceBook::BookDefinitionError do
+      spec.verify_keys!([:bar, :hello, :foo])
+    end
+
+    reported_missing = extract_missing_keys(error_1.message)
+    assert_equal reported_missing.sort, %w(baz)
+
+    reported_unexpected = extract_unexpected_keys(error_1.message)
+    assert_equal reported_unexpected.sort, %w(hello)
+
+    error_2 = assert_raises ReferenceBook::BookDefinitionError do
+      spec.verify_keys!([:one, :two, :three])
+    end
+
+    reported_missing = extract_missing_keys(error_2.message)
+    assert_equal reported_missing.sort, %w(bar baz foo)
+
+    reported_unexpected = extract_unexpected_keys(error_2.message)
+    assert_equal reported_unexpected.sort, %w(one three two)
+  end
+
+
+private
+  
+  def make_locked_spec(keys = nil)
+    keys ||= [:foo, :bar, :baz]
+    ReferenceBook::Setup::LockedBookSpec.new(keys)
+  end
+
+
+  def extract_missing_keys(msg)
+    reg = /missing keys\: \[([a-zA-Z_\-\, ]+)\]/
+    data = reg.match msg
+    data[1].split(', ')
+  end
+
+
+  def extract_unexpected_keys(msg)
+    reg = /unexpected keys\: \[([a-zA-Z_\-\, ]+)\]/
+    data = reg.match msg
+    data[1].split(', ')
+  end
+
+end

data/test/setup/writer_test.rb

@@ -0,0 +1,202 @@
+require 'test_helper'
+
+class WriterTest < Minitest::Test
+
+  def test_initialize_with_locked_spec
+    assert ReferenceBook::Setup::Writer.new(make_locked_spec)
+  end
+
+
+  def test_initialize_with_nil
+    assert ReferenceBook::Setup::Writer.new(nil)
+    assert ReferenceBook::Setup::Writer.new
+  end
+
+
+  def test_create_book_normal
+    writer = ReferenceBook::Setup::Writer.new
+    collector = make_collector
+
+    book = writer.create_book_with('title', 'key', collector)
+
+    assert book.is_a?(ReferenceBook::Book)
+    assert_equal "ReferenceBook::Book::Title", book.class.name
+    assert book.frozen?
+    assert_equal "Title", book.title
+    assert_equal :key, book.library_key
+  end
+
+
+
+  def test_attributes_of_created_book
+    collector = make_collector one: 1, two: 2, three: '3'
+    writer = ReferenceBook::Setup::Writer.new
+    book = writer.create_book_with('CheckAttrs', nil, collector)
+
+    assert_equal collector.one, book.one
+    assert_equal collector.two, book.two
+    assert_equal collector.three, book.three
+
+    assert_equal "CheckAttrs", book.title
+    assert_equal :check_attrs, book.library_key
+  end
+
+
+
+  def test_create_book_without_title
+    writer = ReferenceBook::Setup::Writer.new
+    collector = make_collector
+
+    book = writer.create_book_with(nil, nil, collector)
+
+    assert book.is_a?(ReferenceBook::Book)
+    assert_equal "ReferenceBook::Book::Default", book.class.name
+    assert book.frozen?
+    assert_equal "Default", book.title
+    assert_equal :default, book.library_key
+  end
+
+
+
+  def test_create_book_without_explicit_key
+    writer = ReferenceBook::Setup::Writer.new
+    collector = make_collector
+
+    book = writer.create_book_with('MyTitle', nil, collector)
+
+    assert book.is_a?(ReferenceBook::Book)
+    assert book.frozen?
+    assert_equal "MyTitle", book.title
+    assert_equal :my_title, book.library_key
+  end
+
+
+
+  def test_create_book_with_symbol_key_parameter
+    writer = ReferenceBook::Setup::Writer.new
+    collector = make_collector
+
+    book = writer.create_book_with('titlea', :"Not Nice", collector)
+
+    assert book.is_a?(ReferenceBook::Book)
+    assert book.frozen?
+    assert_equal "Titlea", book.title
+    assert_equal :"Not Nice", book.library_key
+  end
+
+
+
+
+  def test_create_book_with_duplicated_library_key
+    writer = ReferenceBook::Setup::Writer.new
+    collector = make_collector
+    
+    book = writer.create_book_with('TitleOne', :existing_key, collector)
+    ReferenceBook::Library.store(book)
+
+    assert_raises ReferenceBook::BookDefinitionError do
+      writer.create_book_with('TitleTwo', :existing_key, collector)
+    end
+
+    book = writer.create_book_with('TitleThree', :new_key, collector)
+    assert book.is_a?(ReferenceBook::Book)
+
+    ReferenceBook::Library.empty!
+  end
+
+
+
+  def test_create_book_with_spec_pass
+    spec = make_locked_spec [:one, :two, :three]
+    writer = ReferenceBook::Setup::Writer.new(spec)
+    collector = make_collector one: 1, two: 2, three: 3
+
+    book = writer.create_book_with('with spec pass', nil, collector)
+
+    assert book.is_a?(ReferenceBook::Book)
+    assert_equal "ReferenceBook::Book::Withspecpass", book.class.name
+    assert book.frozen?
+    assert_equal "Withspecpass", book.title
+    assert_equal :with_spec_pass, book.library_key
+  end
+
+
+
+  def test_create_book_with_spec_fail_missing
+    spec = make_locked_spec [:one, :two, :three]
+    writer = ReferenceBook::Setup::Writer.new(spec)
+    collector = make_collector one: 1, two: 2
+
+    assert_raises ReferenceBook::BookDefinitionError do
+      writer.create_book_with('with spec fail', nil, collector)
+    end
+
+    empty_collector = ReferenceBook::Setup::Collector.new
+
+    assert_raises ReferenceBook::BookDefinitionError do
+      writer.create_book_with('with spec fail', nil, empty_collector)
+    end
+  end
+
+
+  def test_create_book_with_spec_fail_unexpected
+    spec = make_locked_spec [:one, :two, :three]
+    writer = ReferenceBook::Setup::Writer.new(spec)
+    collector = make_collector one: 1, two: 2, three: 3, four: 4
+
+    assert_raises ReferenceBook::BookDefinitionError do
+      writer.create_book_with('with spec fail', nil, collector)
+    end
+
+
+    collector = make_collector foo: 1, bar: 2
+
+    assert_raises ReferenceBook::BookDefinitionError do
+      writer.create_book_with('with spec fail', nil, collector)
+    end
+  end
+
+
+  def test_create_book_with_spec_fail_missing_and_unexpected
+    spec = make_locked_spec [:one, :two, :three]
+    writer = ReferenceBook::Setup::Writer.new(spec)
+    collector = make_collector one: 1, two: 2, four: 4
+
+    assert_raises ReferenceBook::BookDefinitionError do
+      writer.create_book_with('with spec fail', nil, collector)
+    end
+  end
+
+
+
+private
+  
+  def make_collector(keys = {})
+    collector = ReferenceBook::Setup::Collector.new
+    if keys.any?
+      keys.each_pair { |k, v| collector[k] = v }
+    else
+      collector.foo = 11
+      collector.bar = 22
+      collector.baz = 33
+    end
+    collector
+  end
+
+
+  def make_locked_spec(keys = nil)
+    keys ||= [:foo, :bar, :baz]
+    ReferenceBook::Setup::LockedBookSpec.new(keys)
+  end
+
+
+
+  def debug(book)
+    puts <<-EOS
+
+    ----
+    book: #{book}
+    ----
+    EOS
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'reference_book'
+
+require 'minitest/autorun'
+require 'minitest/pride'

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: reference_book
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tommaso Pavese
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: minitest
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  prerelease: false
+  type: :development
+description: A multi-context configuration library and DSL. ReferenceBook provides an easy interface to define, validate and query multi-context configuration data.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/config.rb
+- examples/interface_and_use.rb
+- examples/rails_controllers_and_views.rb
+- examples/rails_models.rb
+- lib/reference_book.rb
+- lib/reference_book/book.rb
+- lib/reference_book/errors.rb
+- lib/reference_book/inflector.rb
+- lib/reference_book/library.rb
+- lib/reference_book/setup.rb
+- lib/reference_book/setup/collector.rb
+- lib/reference_book/setup/locked_book_spec.rb
+- lib/reference_book/setup/writer.rb
+- lib/reference_book/version.rb
+- reference_book.gemspec
+- test/book_test.rb
+- test/inflector_test.rb
+- test/library_test.rb
+- test/reference_book_test.rb
+- test/setup/collector_test.rb
+- test/setup/locked_book_spec_test.rb
+- test/setup/writer_test.rb
+- test/test_helper.rb
+homepage: https://github.com/tompave/reference_book
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.2.2
+signing_key:
+specification_version: 4
+summary: A multi-context configuration library and DSL.
+test_files:
+- test/book_test.rb
+- test/inflector_test.rb
+- test/library_test.rb
+- test/reference_book_test.rb
+- test/setup/collector_test.rb
+- test/setup/locked_book_spec_test.rb
+- test/setup/writer_test.rb
+- test/test_helper.rb