reference_book 0.0.1

data/lib/reference_book/setup/writer.rb

@@ -0,0 +1,70 @@
+class ReferenceBook::Setup::Writer
+
+  
+  def initialize(book_spec = nil)
+    @book_spec = book_spec
+  end
+
+
+
+  def create_book_with(raw_title, raw_library_key, collector)
+    values = collector.to_h
+    verify_values!(values)
+    
+    book_title, library_key = sanitize_title_and_key(raw_title, raw_library_key)
+
+    verify_library_key!(library_key)
+
+    values[:title] = book_title
+    values[:library_key] = library_key
+
+    write_book_with(book_title, values)
+  end
+
+
+private
+
+
+  def write_book_with(title, hash)
+    template = define_book_struct_with(title, hash.keys)
+    book = template.new
+    hash.each_pair { |k, v| book[k] = v }
+    book.freeze
+    book
+  end
+
+
+
+
+  def define_book_struct_with(title, keys)
+    ReferenceBook::Book.new(title, *keys)
+  end
+
+
+
+  def verify_values!(values)
+    @book_spec.verify_keys!(values.keys) if @book_spec
+  end
+
+
+  def verify_library_key!(key)
+    ReferenceBook::Library.verify_library_key!(key)
+  end
+
+
+  def sanitize_title_and_key(raw_title, raw_library_key)
+    raw_title ||= "Default"
+    book_title = ReferenceBook::Inflector.constantize(raw_title)
+
+    # If we have an explicit key, we just ensure it's a symbol,
+    # if we don't have an explicit key, we adapt the title
+    if raw_library_key
+      library_key = raw_library_key.to_sym
+    else
+      library_key = ReferenceBook::Inflector.make_key(raw_title)
+    end
+
+    [book_title, library_key]
+  end
+
+end

data/lib/reference_book/setup.rb

@@ -0,0 +1,2 @@
+module ReferenceBook::Setup
+end

data/lib/reference_book/version.rb

@@ -0,0 +1,3 @@
+module ReferenceBook
+  VERSION = "0.0.1"
+end

data/lib/reference_book.rb

@@ -0,0 +1,52 @@
+module ReferenceBook; end
+
+require 'reference_book/book'
+require 'reference_book/errors'
+require 'reference_book/inflector'
+require 'reference_book/library'
+require 'reference_book/setup'
+require 'reference_book/setup/collector'
+require 'reference_book/setup/locked_book_spec'
+require 'reference_book/setup/writer'
+require 'reference_book/version'
+
+
+module ReferenceBook
+  class << self
+
+    attr_reader :locked_book_spec
+
+
+    # to lock the structure of Books, optional
+    #
+    # ReferenceBook.define_book_structure :attr_1, :attr_2, 'attr_3', ...
+    #
+    def define_book_structure(*book_keys)
+      @locked_book_spec = Setup::LockedBookSpec.new(book_keys)
+    end
+
+
+
+    # with block with 1 argument
+    #
+    # ReferenceBook.write_book(title: :sym_or_str) do |book|
+    #   book.some_prop = "foobar"
+    # end
+    #
+    def write_book(opts = {}, &block)
+      collector = Setup::Collector.new
+      yield collector
+
+      writer = Setup::Writer.new(locked_book_spec)
+      book = writer.create_book_with(opts[:title], opts[:library_key], collector)
+
+      library.store(book)
+    end
+
+
+    def library
+      ReferenceBook::Library
+    end
+
+  end
+end

data/reference_book.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reference_book/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reference_book"
+  spec.version       = ReferenceBook::VERSION
+  spec.author        = "Tommaso Pavese"
+  spec.summary       = "A multi-context configuration library and DSL."
+  spec.description   = "A multi-context configuration library and DSL. ReferenceBook provides an easy interface to define, validate and query multi-context configuration data."
+  spec.homepage      = "https://github.com/tompave/reference_book"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", '~> 10.0'
+
+  spec.add_development_dependency 'minitest', '~> 5.3'
+end

data/test/book_test.rb

@@ -0,0 +1,118 @@
+require 'test_helper'
+
+class BookTest < Minitest::Test
+
+  BOOK_STRUCT = ReferenceBook::Book.new("Example", :foo, :bar)
+
+  def setup
+    super
+    @book = BOOK_STRUCT.new
+  end
+
+
+  def test_name
+    assert_equal "ReferenceBook::Book::Example", @book.class.name
+  end
+
+
+  def test_setters
+    assert_respond_to @book, :foo=
+    assert_respond_to @book, :bar=
+    refute_respond_to @book, :baz=
+  end
+
+
+  def test_getters
+    assert_respond_to @book, :foo
+    assert_respond_to @book, :bar
+    refute_respond_to @book, :baz
+  end
+
+
+
+  def test_set_with_method
+    @book.foo = 1234
+    assert_equal 1234, @book.foo
+  end
+
+
+  def test_set_with_hash_access
+    @book[:foo] = 1234
+    assert_equal 1234, @book.foo
+  end
+
+
+
+  def test_get_with_method
+    @book.foo = 9876
+    assert_equal 9876, @book.foo
+  end
+
+
+  def test_get_with_hash_access
+    @book.foo = 9876
+    assert_equal 9876, @book[:foo]
+  end
+
+
+  def test_creation
+    template = ReferenceBook::Book.new("Foobar", :foo, :bar)
+    assert_equal Class, template.class
+    assert_equal "ReferenceBook::Book::Foobar", template.name
+
+    book = template.new
+    assert book.is_a?(ReferenceBook::Book)
+    assert_equal "ReferenceBook::Book::Foobar", book.class.name
+
+    refute_equal book, @book
+    assert_equal book, template.new
+  end
+
+
+
+  def test_to_h
+    assert_equal Hash, @book.to_h.class
+    assert_equal 2, @book.to_h.size
+    assert_includes @book.to_h.keys, :foo
+    assert_includes @book.to_h.keys, :bar
+    assert_nil @book.to_h[:foo]
+    assert_nil @book.to_h[:bar]
+
+    @book.foo = 11
+    @book.bar = 22
+    assert_equal 11, @book.to_h[:foo]
+    assert_equal 22, @book.to_h[:bar]
+  end
+
+
+
+  def test_freeze_methods
+    assert_respond_to @book, :freeze
+    assert_respond_to @book, :frozen?
+  end
+
+
+  def test_freeze_effects
+    refute @book.frozen?
+    @book.freeze
+    assert @book.frozen?
+  end
+
+
+  def test_fronzen_book_attributes
+    assert_nil @book.foo
+    @book.foo = 1
+    assert_equal 1, @book.foo
+    @book.freeze
+    assert_equal 1, @book.foo
+
+    assert_raises RuntimeError do
+      @book.foo = 2
+    end
+
+    assert_raises RuntimeError do
+      @book.bar = 3
+    end
+  end
+
+end

data/test/inflector_test.rb

@@ -0,0 +1,81 @@
+require 'test_helper'
+
+class InflectorTest < Minitest::Test
+
+  def test_constantize_simple_symbol
+    result = ReferenceBook::Inflector.constantize :hello
+    assert_equal "Hello", result
+  end
+
+
+  def test_constantize_two_words
+    result = ReferenceBook::Inflector.constantize 'hello world'
+    assert_equal "Helloworld", result
+  end
+
+
+  def test_constantize_already_ok
+    result = ReferenceBook::Inflector.constantize 'HelloWorld'
+    assert_equal "HelloWorld", result
+  end
+
+
+  def test_constantize_other_chars
+    result = ReferenceBook::Inflector.constantize "hello-world!11"
+    assert_equal "Helloworld", result
+  end
+
+
+  def test_constantize_nil
+    result = ReferenceBook::Inflector.constantize nil
+    assert_equal nil, result
+  end
+
+
+  def test_constantize_empty
+    result = ReferenceBook::Inflector.constantize ''
+    assert_equal nil, result
+  end
+
+
+  def test_make_key_simple
+    result = ReferenceBook::Inflector.make_key "hello"
+    assert_equal :hello, result
+  end
+
+
+  def test_make_key_two_words
+    result = ReferenceBook::Inflector.make_key "hello world"
+    assert_equal :hello_world, result
+  end
+
+
+  def test_make_key_camel
+    result = ReferenceBook::Inflector.make_key "HelloWorldDear"
+    assert_equal :hello_world_dear, result
+  end
+
+
+  def test_make_key_symbol
+    result = ReferenceBook::Inflector.make_key :hello
+    assert_equal :hello, result
+  end
+
+
+  def test_make_key_upcase
+    result = ReferenceBook::Inflector.make_key "heLLO"
+    assert_equal :he_llo, result
+  end
+
+
+  def test_make_key_with_numbers
+    result = ReferenceBook::Inflector.make_key "hello123_world"
+    assert_equal :hello123_world, result
+  end
+
+
+  def test_make_key_nil
+    result = ReferenceBook::Inflector.make_key nil
+    assert_equal nil, result
+  end
+end

data/test/library_test.rb

@@ -0,0 +1,166 @@
+require 'test_helper'
+
+class LibraryTest < Minitest::Test
+
+
+  def setup
+    super
+    ReferenceBook::Library.empty!
+  end
+
+
+  def teardown
+    super
+    ReferenceBook::Library.empty!
+  end
+
+
+
+  def test_shelf_class
+    assert_equal Hash, ReferenceBook::Library.shelf.class
+  end
+
+
+  def test_index_class
+    assert_equal Array, ReferenceBook::Library.index.class
+  end
+
+
+
+  def test_with_no_book_stored
+    assert_empty ReferenceBook::Library.index
+    assert_empty ReferenceBook::Library.shelf
+  end
+
+
+  def test_store
+    refute_respond_to ReferenceBook::Library, :one
+  
+    book = make_book(:one)
+    result = ReferenceBook::Library.store(book)
+
+    assert_equal book, result
+
+    refute_empty ReferenceBook::Library.index
+    assert_includes ReferenceBook::Library.index, :one
+    assert_equal 1, ReferenceBook::Library.index.size
+
+    refute_empty ReferenceBook::Library.shelf
+    assert_equal book, ReferenceBook::Library.shelf[:one]
+    assert_equal 1, ReferenceBook::Library.shelf.size
+
+    assert_respond_to ReferenceBook::Library, :one
+    assert_equal book, ReferenceBook::Library.one
+  end
+
+
+
+  def test_store_incremental
+    assert_empty ReferenceBook::Library.index
+    assert_empty ReferenceBook::Library.shelf
+
+    book_1 = make_book(:one)
+    book_2 = make_book(:two)
+
+    ReferenceBook::Library.store book_1
+
+    assert_equal 1, ReferenceBook::Library.index.size
+    assert_includes ReferenceBook::Library.index, :one
+
+    assert_equal 1, ReferenceBook::Library.shelf.size
+    assert_equal book_1, ReferenceBook::Library.shelf[:one]
+
+    assert_respond_to ReferenceBook::Library, :one
+    assert_equal book_1, ReferenceBook::Library.one
+
+
+    ReferenceBook::Library.store book_2
+
+    assert_equal 2, ReferenceBook::Library.index.size
+    assert_includes ReferenceBook::Library.index, :one
+    assert_includes ReferenceBook::Library.index, :two
+
+    assert_equal 2, ReferenceBook::Library.shelf.size
+    assert_equal book_1, ReferenceBook::Library.shelf[:one]
+    assert_equal book_2, ReferenceBook::Library.shelf[:two]
+
+    assert_respond_to ReferenceBook::Library, :one
+    assert_equal book_1, ReferenceBook::Library.one
+    assert_respond_to ReferenceBook::Library, :two
+    assert_equal book_2, ReferenceBook::Library.two
+  end
+
+
+
+  def test_empty
+    book = make_book(:one)
+    ReferenceBook::Library.store(book)
+
+    assert_includes ReferenceBook::Library.index, :one
+    assert_equal book, ReferenceBook::Library.shelf[:one]
+    assert_respond_to ReferenceBook::Library, :one
+
+    ReferenceBook::Library.empty!
+
+    assert_empty ReferenceBook::Library.index
+    assert_empty ReferenceBook::Library.shelf
+    refute_respond_to ReferenceBook::Library, :one
+  end
+
+
+
+
+  def test_hash_access
+    assert_nil ReferenceBook::Library[:one]
+    assert_nil ReferenceBook::Library[:two]
+
+    book = make_book(:one)
+    result = ReferenceBook::Library.store(book)
+
+    assert_equal book, ReferenceBook::Library[:one]
+    assert_nil ReferenceBook::Library[:two]
+  end
+
+
+
+  def test_accessor_methods
+    refute_respond_to ReferenceBook::Library, :one
+    refute_respond_to ReferenceBook::Library, :two
+
+    book = make_book(:one)
+    result = ReferenceBook::Library.store(book)
+
+    assert_respond_to ReferenceBook::Library, :one
+    assert_equal book, ReferenceBook::Library.one
+    refute_respond_to ReferenceBook::Library, :two
+  end
+
+
+
+  def test_verify_library_key
+    assert_nil ReferenceBook::Library.verify_library_key! :one
+    assert_nil ReferenceBook::Library.verify_library_key! :two
+
+    ReferenceBook::Library.store(make_book(:one))
+
+    assert_raises ReferenceBook::BookDefinitionError do
+      ReferenceBook::Library.verify_library_key! :one
+    end
+    assert_nil ReferenceBook::Library.verify_library_key! :two
+  end
+
+
+
+private
+  
+  BOOK_STRUCT = ReferenceBook::Book.new("ExampleLib", :title, :library_key)
+
+  def make_book(key)
+    book = BOOK_STRUCT.new
+    book.title = "#{key}_title"
+    book.library_key = key
+    book
+  end
+
+
+end

data/test/reference_book_test.rb

@@ -0,0 +1,197 @@
+require 'test_helper'
+
+class ReferenceBookTest < Minitest::Test
+
+
+  def teardown
+    super
+    ReferenceBook::Library.empty!
+    ReferenceBook.instance_eval { @locked_book_spec = nil }
+  end
+
+
+
+  def test_define_book_structure
+    assert_nil ReferenceBook.locked_book_spec
+    spec = ReferenceBook.define_book_structure :one, :two
+
+    assert spec.is_a?(ReferenceBook::Setup::LockedBookSpec) 
+    assert_equal spec, ReferenceBook.locked_book_spec
+  end
+
+
+  def test_define_book_structure_fail
+    assert_nil ReferenceBook.locked_book_spec
+
+    assert_raises ReferenceBook::LockedBookSpecError do
+      ReferenceBook.define_book_structure
+    end
+  end
+
+
+
+
+
+  def test_write_book_normal
+    assert_empty ReferenceBook::Library.index
+    assert_empty ReferenceBook::Library.shelf
+    refute_respond_to ReferenceBook::Library, :ref_book
+
+    book = ReferenceBook.write_book(title: "RefBook") do |b|
+      b.foo = 111
+      b.bar = 222
+    end
+
+    assert book.is_a?(ReferenceBook::Book)
+    assert_equal "ReferenceBook::Book::RefBook", book.class.name
+    assert book.frozen?
+    assert_equal "RefBook", book.title
+    assert_equal :ref_book, book.library_key
+
+    assert_equal 111, book.foo
+    assert_equal 222, book.bar
+
+    assert_equal 1, ReferenceBook::Library.index.size
+    assert_equal 1, ReferenceBook::Library.shelf.size
+
+    assert_includes ReferenceBook::Library.index, :ref_book
+    assert_respond_to ReferenceBook::Library, :ref_book
+    assert_equal book, ReferenceBook::Library.ref_book
+
+    assert_equal book, ReferenceBook::Library.shelf[:ref_book]
+  end
+
+  
+
+
+  def test_write_more_than_one_book
+    assert_empty ReferenceBook::Library.index
+    assert_empty ReferenceBook::Library.shelf
+
+    ReferenceBook.write_book(title: "RefBookA") do |b|
+      b.foo = 111
+      b.bar = 222
+    end
+
+    assert_equal 1, ReferenceBook::Library.index.size
+    assert_equal 1, ReferenceBook::Library.shelf.size
+
+    ReferenceBook.write_book(title: "RefBookB") do |b|
+      b.foo = 111
+      b.bar = 222
+    end
+
+    assert_equal 2, ReferenceBook::Library.index.size
+    assert_equal 2, ReferenceBook::Library.shelf.size
+  end
+
+
+
+
+
+  def test_attributes_of_created_book
+    book = ReferenceBook.write_book(title: "RefBookC") do |b|
+      b.foo = 111
+      b.bar = 222
+      b.baz = 333
+    end
+
+    assert_equal 111, book.foo
+    assert_equal 222, book.bar
+    assert_equal 333, book.baz
+  end
+
+
+
+
+  def test_write_book_duplicated_key
+    book = ReferenceBook.write_book(title: "Hello", library_key: :existing) do |b|
+      b.foo = 'hello'
+    end
+
+    assert book.is_a?(ReferenceBook::Book)
+    assert_equal 1, ReferenceBook::Library.index.size
+
+    assert_raises ReferenceBook::BookDefinitionError do
+      ReferenceBook.write_book(title: "HelloA", library_key: :existing) do |b|
+        b.foo = 'hello'
+      end
+    end
+
+
+    book = ReferenceBook.write_book(title: "HelloB", library_key: :another) do |b|
+      b.foo = 'hello'
+    end
+
+    assert book.is_a?(ReferenceBook::Book)
+    assert_equal 2, ReferenceBook::Library.index.size
+  end
+
+
+
+  def test_create_book_with_spec_pass
+    ReferenceBook.define_book_structure :one, :two, :three
+
+    book = ReferenceBook.write_book(title: "aaaa") do |b|
+      b.one = 1
+      b.two = 2
+      b.three = 3
+    end
+
+    assert book.is_a?(ReferenceBook::Book)
+    assert_equal 1, ReferenceBook::Library.index.size
+  end
+
+
+
+  def test_create_book_with_spec_fail_missing
+    ReferenceBook.define_book_structure :one, :two, :three
+
+    assert_raises ReferenceBook::BookDefinitionError do
+      ReferenceBook.write_book(title: "bbbb") do |b|
+        b.one = 1
+        b.two = 2
+      end
+    end
+  end
+
+
+  def test_create_book_with_spec_fail_unexpected
+    ReferenceBook.define_book_structure :one, :two, :three
+
+    assert_raises ReferenceBook::BookDefinitionError do
+      ReferenceBook.write_book(title: "cccc") do |b|
+        b.one = 1
+        b.two = 2
+        b.three = 3
+        b.four = 4
+      end
+    end
+  end
+
+
+  def test_create_book_with_spec_fail_missing_and_unexpected
+    ReferenceBook.define_book_structure :one, :two, :three
+
+    assert_raises ReferenceBook::BookDefinitionError do
+      ReferenceBook.write_book(title: "dddd") do |b|
+        b.one = 1
+        b.four = 4
+      end
+    end
+  end
+
+
+
+
+  def test_library
+    assert_equal ReferenceBook::Library, ReferenceBook.library
+  end
+
+
+
+  def test_locked_book_spec
+    assert_respond_to ReferenceBook, :locked_book_spec
+  end
+
+end