abstract_mapper 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 805663151f746aef76f5fec0a546289ec9d94f22
-  data.tar.gz: f6f64a22fe401d9a53d09bc10d0555445f41b66d
+  metadata.gz: 0547716c6b580abf30fd1b16d2e42cb2656971da
+  data.tar.gz: 7c793b44bebc3157b32cb754e76fd8e7c550a242
 SHA512:
-  metadata.gz: 84df16b02fe5e3d555ba1829f2876d97383bee2e1ce6c0ac382b2894339bc429aa0ff5bc39c0b048567e44c7dc1b392a457334dc2e94694692ebbfe967bfc453
-  data.tar.gz: 525f8da10ebddb8f46c6448d2b2c679d5621b5e72632c8a7b3b468ed7c5983513bbb6871e747ac2290a8a22a24667e8a42578230d0953b5cbc814071fda3ec9c
+  metadata.gz: 89772b4b3618585644e6224b93abd13276d1ed057be038ce38c677b752aefacc424fa3d05076810555afe976a45d4e059c82eb96cb7acc2b9f29b96fa66c7f15
+  data.tar.gz: 688f0f055d98a12c7558948b5191c9f1e7fe0d43ac740929339fb3a1e7a700252273a535430c21d3676ecf229ba61257661890711a343f333c66bc9fdce2da5a

data/.travis.yml

@@ -1,6 +1,7 @@
 ---
 language:     ruby
 cache:        bundler
+script:       "bundle exec rake test:coverage:run"
 bundler_args: --without metrics
 rvm:
   - '1.9.3'

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+## v0.0.2 2015-08-06
+
+### Added
+
+* Coersion of command arguments into the the node's attributes (nepalez)
+
+### Changed
+
+* Removed force ordering of rules (nepalez)
+* Nodes takes hash of attributes instead of array (nepalez)
+
+### Deleted
+
+* Removed shared examples for mapper. The mapper should be specified by integration tests (nepalez)
+
+### Bugs fixed
+
+* Fixed the `:transforming_immutable_data` shared examples so that it can deal with singleton inputs (nepalez)
+* Fixed the `:mapping_immutable_input` shared examples so that it can deal with singleton inputs (nepalez)
+* Fixed typo in `WrongRule` exception message (nepalez)
+
+### Internal
+
+* Switched to `transproc` gem v0.3.0 (nepalez)
+* Added the `Functions#identity` pure function (nepalez)
+* Made the `Rule` to fully implement the interface, including method `.transproc`, `#optimize?`, `#optimize` that by default change nothing (nepalez)
+* Made the `.composer` setting private for all rules (`Rule`, `SoleRule`, `PairRule`) (nepalez)
+* Switched to 'ice_nine' gem for freezing instances deeply (nepalez)
+* Added `ice_double` feature to specs (nepalez)
+* Added `AbstractMapper::Command` that can convert arguments of the command to the node's (nepalez)
+* Switched to `virtus` attributes (nepalez)
+
+[Compare v0.0.1...v0.0.2](https://github.com/nepalez/abstract_mapper/compare/v0.0.1...v0.0.2)
+
 ## v0.0.1 2015-07-04
 
 This is the first published version of the gem.

data/Gemfile

@@ -3,7 +3,5 @@ source "https://rubygems.org"
 gemspec
 
 group :metrics do
-  gem "hexx-suit", "~> 2.2" if RUBY_ENGINE == "ruby"
+  gem "hexx-suit", "~> 2.3" if RUBY_ENGINE == "ruby" && RUBY_VERSION >= "2.1"
 end
-
-gem "thread_safe" # Why on earth I need this here?!

data/README.md

@@ -62,7 +62,7 @@ The following example represents an oversimplified version of the [faceter] gem.
 
 Every node should implement the `#transproc` method that transforms some input data to the output.
 
-When you need attributes, assign them via initializer:
+When you need attributes, assign them using [virtus] method `attribute`:
 
 ```ruby
 require "abstract_mapper"
@@ -79,21 +79,19 @@ module Faceter
     end
   end
 
-  # The node to define a renaming of key in a tuple
+  # The node to define a renaming of keys in a tuple
   class Rename < AbstractMapper::Node
-    def initialize(key, **options)
-      @key = key
-      @new_key = options.fetch(:to)
-      super
-    end
+    attribute :keys
 
     def transproc
-      Transproc::HashTransformations[:rename_keys, @key => @new_key]
+      Transproc::HashTransformations[:rename_keys, keys]
     end
   end
 end
 ```
 
+[virtus]: https://github.com/solnic/virtus
+
 ### Define optimization rules
 
 AbstractMapper defines 2 rules `AbstractMapper::SoleRule` and `AbstractMapper::PairRule`. The first one is applicable to every single node to check if it can be optimized by itself, the second one takes two consecutive nodes and either return them unchanged, or merges them into more time-efficient node.
@@ -125,29 +123,47 @@ module Faceter
   # into the one list, containing subnodes (entries) from both sources.
   class CompactLists < AbstractMapper::PairRule
     def optimize?
-      nodes.join(:|) { |n| n.is_a? List }
+      nodes.map { |n| n.is_a? List }.reduce(:&)
     end
 
     def optimize
       List.new { nodes.map(:entries).flatten }
     end
   end
+
+  # Two consecutive renames can be merged
+  class CompactRenames < AbstractMapper::PairRule
+    def optimize?
+      nodes.map { |n| n.is_a? Rename }.reduce(:&)
+    end
+
+    def optimize
+      Rename.new nodes.map(&:attributes).reduce(:merge)
+    end
+  end
 end
 ```
 
 ### Register commands and rules
 
-Now that both the nodes (transformers) and optimization rules are defined, its time to register them for the mapper:
+Now that both the nodes (transformers) and optimization rules are defined, its time to register them for the mapper.
+
+You can coerce command argumets into node attributes. The coercer is expected to return a hash:
 
 ```ruby
 module Faceter
   class Mapper < AbstractMapper
     configure do
-      command :list,   List
-      command :rename, Rename
+      command :list, List
+
+      # `:foo, to: :bar` becomes `{ keys: { foo: :bar } }`
+      command :rename, Rename do |name, opts|
+        { keys: { name => opts.fetch(:to) } }
+      end
 
       rule RemoveEmptyLists
       rule CompactLists
+      rule CompactRenames
     end
   end
 end
@@ -184,7 +200,7 @@ All the rules are applied before initializing `my_mapper`, so the AST will be th
 
 ```ruby
 my_mapper.tree
-# => <Root <List [<Rename(foo:, to: :bar)>, <Rename(:baz, to: :qux)>]>
+# => <Root [<List [<Rename(foo: :bar, baz: :qux)>]>]>
 ```
 
 Testing

data/Rakefile

@@ -1,10 +1,7 @@
 # encoding: utf-8
-begin
-  require "bundler/setup"
-rescue LoadError
-  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
-  exit
-end
+
+require "rubygems"
+require "bundler/setup"
 
 # Loads bundler tasks
 Bundler::GemHelper.install_tasks
@@ -20,7 +17,7 @@ end
 
 # Sets the Hexx::RSpec :test task to default
 task :default do
-  system "bundle exec rspec spec"
+  system "bundle exec rake test:coverage:run"
 end
 
 desc "Runs mutation metric before the first evil being kept"

data/abstract_mapper.gemspec

@@ -19,8 +19,9 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = ">= 2.1"
 
-  gem.add_runtime_dependency "transproc", "~> 0.2", "> 0.2.3"
+  gem.add_runtime_dependency "ice_nine", "~> 0.11"
+  gem.add_runtime_dependency "transproc", "~> 0.3", ">= 0.3.1"
 
-  gem.add_development_dependency "hexx-rspec", "~> 0.4"
+  gem.add_development_dependency "hexx-rspec", "~> 0.5"
 
 end # Gem::Specification

data/config/metrics/STYLEGUIDE

@@ -16,18 +16,17 @@ https://github.com/dkubb/styleguide/blob/master/RUBY-STYLE
   - FEATURE - for adding new features, or backward-compatible changes;
   - CHANGE - for backward-incompatible changes;
   - BUG FIX - for fixing bugs;
-  - REFACTORING - for other changes of the code not affecting the API;
-  - OTHER - for changes in documentaton, metrics etc, not touching the code;
+  - INTERNAL - for other changes of the code, documentaton, metrics etc.;
   - VERSION - for version changes.
 
-* Always separate commits of different types (such as FEATURE and CHANGE).
+* Always separate commits of different types (such as FEATURE and INTERNAL).
 
-* Try to separate various features from each other.
+* Separate various features from each other.
 
 * Include specification to the same commit as the code.
 
 * Run all tests before making a commit.
-  Never commit the code that break unit tests.
+  Never commit the code that break a specification.
 
 * Use metric (run `rake check`) before making a commit.
 
@@ -37,9 +36,9 @@ https://github.com/dkubb/styleguide/blob/master/RUBY-STYLE
 
     http://semver.org/
 
-* For versions name the commit after a version number, following the pattern:
+* For versions name the commit after a version number:
 
-    VERSION 1.0.0-rc2
+    [VERSION] 1.0.0-rc2
 
 
 == Formatting:
@@ -71,7 +70,7 @@ https://github.com/dkubb/styleguide/blob/master/RUBY-STYLE
 
 == Syntax:
 
-* Write for 2.0.
+* Write for 1.9.3+
 
 * Use double quotes
   
@@ -89,14 +88,13 @@ https://github.com/dkubb/styleguide/blob/master/RUBY-STYLE
   of thumb: If you have to use outer parentheses, you are using the
   wrong operators.)
 
-* Avoid double negation (!!), unless Null Objects are expected.
-  
+* Avoid double negation (!!), unless Null Object is expected.
+
     http://devblog.avdi.org/2011/05/30/null-objects-and-falsiness
 
 * Avoid multiline ?:, use if.
 
-* Use {...} when defining blocks on one line. Use do...end for multiline
-  blocks.
+* Use {...} when defining blocks on one line. Use do...end for multiline blocks.
 
 * Avoid return where not required.
 
@@ -133,7 +131,8 @@ https://github.com/dkubb/styleguide/blob/master/RUBY-STYLE
 
 * Prefer map over collect, detect over find, select over find_all.
 
-* Use def self.method to define singleton methods.
+* Use def self.method to define singleton methods. Extend modules
+  when you need many singleton methods.
 
 * Avoid alias when alias_method will do.
 
@@ -141,9 +140,9 @@ https://github.com/dkubb/styleguide/blob/master/RUBY-STYLE
 == Comments:
 
 * Use YARD and its conventions for API documentation. Don't put an
-  empty line between the comment block and the def.
+  empty line between the comment block and the def. Use empty comment line.
 
-* Comments longer than a word are capitalized and use punctuation.
+* Capitalize comments longer than a word, and use punctuation.
   Use one space after periods.
 
 * Avoid superfluous comments.

data/lib/abstract_mapper.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+require "ice_nine"
 require "transproc"
 
 require_relative "abstract_mapper/functions"
@@ -8,8 +9,10 @@ require_relative "abstract_mapper/errors/unknown_command"
 require_relative "abstract_mapper/errors/wrong_node"
 require_relative "abstract_mapper/errors/wrong_rule"
 
+require_relative "abstract_mapper/attributes"
 require_relative "abstract_mapper/node"
 require_relative "abstract_mapper/branch"
+require_relative "abstract_mapper/command"
 require_relative "abstract_mapper/commands"
 require_relative "abstract_mapper/builder"
 
@@ -65,7 +68,7 @@ class AbstractMapper
   def initialize
     @tree = self.class.finalize
     @transproc = @tree.transproc
-    freeze
+    IceNine.deep_freeze(self)
   end
 
   # Maps the input data to some output using the transformation,

data/lib/abstract_mapper/attributes.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+class AbstractMapper
+
+  # Defines attributes along with the DSL for setting them
+  #
+  module Attributes
+
+    # @private
+    def self.included(klass)
+      klass.__send__ :extend, DSL
+    end
+
+    # @!attribute [r] attributes
+    #
+    # @return [Hash] The initialized attributes
+    #
+    attr_reader :attributes
+
+    # Initializes the instance with the hash of attributes
+    #
+    # @param [Hash] attributes
+    #
+    def initialize(attributes)
+      @attributes = Functions[:restrict, self.class.attributes][attributes]
+    end
+
+    # Attributes DSL
+    #
+    module DSL
+
+      # Makes a attributes inheritable
+      #
+      # @private
+      #
+      def inherited(klass)
+        attributes.each { |key, value| klass.attribute key, default: value }
+      end
+
+      # Default attributes for the node
+      #
+      # @return [Hash]
+      #
+      def attributes
+        @attributes ||= {}
+      end
+
+      # Declares the attribute
+      #
+      # @param [#to_sym] name
+      # @param [Hash] options
+      # @option options [Object] :default
+      #
+      # @return [undefined]
+      #
+      def attribute(name, options = {})
+        attributes[name.to_sym] = options[:default]
+        define_method(name) { attributes[name.to_sym] }
+      end
+
+    end # module DSL
+
+  end # module Attributes
+
+end # class AbstractMapper

data/lib/abstract_mapper/branch.rb

@@ -6,7 +6,7 @@ class AbstractMapper
   # applied to some level of nested input.
   #
   # Unlike the simple node, describing a transformation of data, the
-  # branch carries a collection of subnodes along with methods to [#rebuild]
+  # branch carries a collection of subnodes along with methods to [#update]
   # itself with the same attributes and different subnodes.
   #
   # Tne branch only stores subnodes and composes transformations.
@@ -32,9 +32,9 @@ class AbstractMapper
     # @return [Branch::Node]
 
     # @private
-    def initialize(*attributes)
+    def initialize(attributes = {})
       @subnodes = block_given? ? yield : []
-      super(*attributes, &nil)
+      super(attributes, &nil)
     end
 
     # Returns a new branch of the same type, with the same attributes,
@@ -43,7 +43,7 @@ class AbstractMapper
     # @example
     #   branch = Branch.new(:foo)
     #   # => <Branch(:foo) []>
-    #   branch.rebuild { Node.new(:bar) }
+    #   branch.update { Node.new(:bar) }
     #   # => <Branch(:foo) [<Node(:bar)>]>
     #
     # @param [Proc] block
@@ -53,8 +53,8 @@ class AbstractMapper
     #
     # @yield block
     #
-    def rebuild(&block)
-      self.class.new(*attributes, &block)
+    def update
+      self.class.new(attributes) { yield }
     end
 
     # @!method each
@@ -73,7 +73,7 @@ class AbstractMapper
     # @return [AbstractMapper::Branch]
     #
     def <<(other)
-      rebuild { entries << other }
+      update { entries << other }
     end
 
     # The composition of transformations from all subnodes of the branch
@@ -97,6 +97,16 @@ class AbstractMapper
       "#{super} [#{map(&:inspect).join(", ")}]"
     end
 
+    # Checks equality of branches by type, attributes and subnodes
+    #
+    # @param [Other] other
+    #
+    # @return [Boolean]
+    #
+    def eql?(other)
+      super && entries.eql?(other.entries)
+    end
+
     private
 
     # Substitutes the name of the class by the special name "Root"

data/lib/abstract_mapper/builder.rb

@@ -22,7 +22,11 @@ class AbstractMapper
       #
       # @return [AbstractMapper::Commands] The registry of DSL commands
       #
-      attr_accessor :commands
+      attr_writer :commands
+
+      def commands
+        @commands ||= AbstractMapper::Commands
+      end
 
     end # eigenclass
 
@@ -61,13 +65,13 @@ class AbstractMapper
       @tree     = node
       @commands = self.class.commands
       instance_eval(&block) if block_given?
-      freeze
+      IceNine.deep_freeze(self)
     end
 
     private # DSL commands
 
     def method_missing(name, *args, &block)
-      node  = @commands[name, *args, &block]
+      node  = @commands[name].call(*args, &block)
       @tree = tree << (node.is_a?(Branch) ? update(node, &block) : node)
     end