anima 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4d3d1052ef69a252eba9f680d8918977ebe21957
-  data.tar.gz: 95726462b39f8b85f7706c5415369eb0e141e48d
+SHA256:
+  metadata.gz: e28b3bf5fb2361a433db0d65938c2a5880921fcffd122e56da5e2a81d4c3bcbd
+  data.tar.gz: 4966ec506c17918b5c2d05ca6c4f41cf02b8227bb18c50dc41edbbce0b098bb4
 SHA512:
-  metadata.gz: 320e39521765b3c969063d635b90c3fc51927b2ac9f1fb46e4c13b02f56a539fb3bf1d57fd8f05742a7fe2b83143c0b3d91c3b3e037a4b142cb3341c7907f9cb
-  data.tar.gz: 73e0f2c5c9dc9901dc0c0ce04b899a3c23c5587ff144794b303e53eff9da2bc13d09ca99ea43ff9600805cc8f3ff58c991ebfe66b1eeb9cf8e9c9a796630e29f
+  metadata.gz: afcb05d47ba54ade5f45f889221fba44c64864d60021e74471a5b4f13c760d379295487a3f7165bfcf08272424be9f7daac49773908657823fe4fd427c5f0e29
+  data.tar.gz: b884903b68754c6f1afbc64ab2df7baab2c74db82462ed46ed54fd2c4b00db11b6ef418617691a78c490ce00642d58f7ed806b8750ceb495c547f08d4a03cc58

data/.circleci/config.yml

@@ -0,0 +1,32 @@
+defaults: &defaults
+  working_directory: ~/anima
+  docker:
+    - image: circleci/ruby:2.6.0
+version: 2
+jobs:
+  unit_specs:
+    <<: *defaults
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rspec spec/unit
+  metrics:
+    <<: *defaults
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rake metrics:rubocop
+      - run: bundle exec rake metrics:reek
+  mutant:
+    <<: *defaults
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rake metrics:mutant
+workflows:
+  version: 2
+  test:
+    jobs:
+      - unit_specs
+      - metrics
+      - mutant

data/Changelog.md

@@ -1,4 +1,8 @@
-# v0.3.0 2015-xx-xx
+# v0.3.1 2018-02-15
+
+* Fix falsy key match detection
+
+# v0.3.0 2015-09-04
 
 Changes:
 

data/Gemfile

@@ -1,9 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
-gem 'mutant',   git: 'https://github.com/mbj/mutant.git',
-                branch: 'fix/anima-update'
-gem 'morpher',  git: 'https://github.com/mbj/morpher.git',
-                branch: 'fix/upgrade-anima'

data/anima.gemspec

@@ -1,8 +1,6 @@
-# encoding: utf-8
-
 Gem::Specification.new do |s|
   s.name     = 'anima'
-  s.version  = '0.3.0'
+  s.version  = '0.3.1'
 
   s.authors  = ['Markus Schirp']
   s.email    = 'mbj@schirp-dso.com'
@@ -20,4 +18,6 @@ Gem::Specification.new do |s|
   s.add_dependency('adamantium',    '~> 0.2')
   s.add_dependency('equalizer',     '~> 0.0.11')
   s.add_dependency('abstract_type', '~> 0.0.7')
+
+  s.add_development_dependency('devtools', '~> 0.1.23')
 end

data/config/reek.yml

@@ -1,100 +1,98 @@
 ---
-UncommunicativeParameterName:
-  accept: []
-  exclude: []
-  enabled: true
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /[A-Z]/
-TooManyMethods:
-  max_methods: 9
-  exclude: []
-  enabled: true
-  max_instance_variables: 2
-UncommunicativeMethodName:
-  accept: []
-  exclude: []
-  enabled: true
-  reject:
-  - !ruby/regexp /^[a-z]$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /[A-Z]/
-LongParameterList:
-  max_params: 2  # TODO: decrease max_params to 2
-  exclude:
-  - Anima::Error#initialize # 3 params
-  enabled: true
-  overrides: {}
-FeatureEnvy:
-  exclude:
-  - Anima#attributes_hash
-  enabled: true
-ClassVariable:
-  exclude: []
-  enabled: true
-BooleanParameter:
-  exclude: []
-  enabled: true
-# Buggy like hell
-IrresponsibleModule:
-  exclude: []
-  enabled: false
-UncommunicativeModuleName:
-  accept: []
-  exclude: []
-  enabled: true
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-NestedIterators:
-  ignore_iterators: []
-  exclude:
-  - Anima::Attribute#define_reader # 2 levels
-  - Anima#included # 2 levels
-  enabled: true
-  max_allowed_nesting: 1
-TooManyStatements:
-  max_statements: 7  # TODO: decrease max_statements to 5 or less
-  exclude: []
-  enabled: true
-DuplicateMethodCall:
-  allow_calls: []
-  exclude: []
-  enabled: true
-  max_calls: 1
-UtilityFunction:
-  max_helper_calls: 1
-  exclude:
-  - Anima::Error#initialize # false positive, calls super
-  enabled: true
-Attribute:
-  exclude: []
-  enabled: false
-UncommunicativeVariableName:
-  accept: []
-  exclude: []
-  enabled: true
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /[A-Z]/
-RepeatedConditional:
-  exclude: []
-  enabled: true
-  max_ifs: 1
-DataClump:
-  exclude: []
-  enabled: true
-  max_copies: 1
-  min_clump_size: 3
-ControlParameter:
-  exclude: []
-  enabled: true
-LongYieldList:
-  max_params: 1
-  exclude: []
-  enabled: true
-# Thats the whole point of this lib, oOo.
-ModuleInitialize:
-  enabled: false
+detectors:
+  UncommunicativeParameterName:
+    accept: []
+    exclude: []
+    enabled: true
+    reject:
+    - '/^.$/'
+    - '/[0-9]$/'
+    - '/[A-Z]/'
+  TooManyMethods:
+    max_methods: 9
+    exclude: []
+    enabled: true
+  UncommunicativeMethodName:
+    accept: []
+    exclude: []
+    enabled: true
+    reject:
+    - '/^[a-z]$/'
+    - '/[0-9]$/'
+    - '/[A-Z]/'
+  LongParameterList:
+    max_params: 2  # TODO: decrease max_params to 2
+    exclude:
+    - Anima::Error#initialize # 3 params
+    enabled: true
+    overrides: {}
+  FeatureEnvy:
+    exclude:
+    - Anima#attributes_hash
+    enabled: true
+  ClassVariable:
+    exclude: []
+    enabled: true
+  BooleanParameter:
+    exclude: []
+    enabled: true
+  # Buggy like hell
+  IrresponsibleModule:
+    exclude: []
+    enabled: false
+  UncommunicativeModuleName:
+    accept: []
+    exclude: []
+    enabled: true
+    reject:
+    - '/^.$/'
+    - '/[0-9]$/'
+  NestedIterators:
+    ignore_iterators: []
+    exclude:
+    - Anima::Attribute#define_reader # 2 levels
+    - Anima#included # 2 levels
+    enabled: true
+    max_allowed_nesting: 1
+  TooManyStatements:
+    max_statements: 7  # TODO: decrease max_statements to 5 or less
+    exclude: []
+    enabled: true
+  DuplicateMethodCall:
+    allow_calls: []
+    exclude: []
+    enabled: true
+    max_calls: 1
+  UtilityFunction:
+    exclude: []
+    enabled: true
+  Attribute:
+    exclude: []
+    enabled: false
+  UncommunicativeVariableName:
+    accept: []
+    exclude: []
+    enabled: true
+    reject:
+    - '/^.$/'
+    - '/[0-9]$/'
+    - '/[A-Z]/'
+  RepeatedConditional:
+    exclude: []
+    enabled: true
+    max_ifs: 1
+  DataClump:
+    exclude: []
+    enabled: true
+    max_copies: 1
+    min_clump_size: 3
+  ControlParameter:
+    exclude: []
+    enabled: true
+  LongYieldList:
+    max_params: 1
+    exclude: []
+    enabled: true
+  # Thats the whole point of this lib, oOo.
+  ModuleInitialize:
+    enabled: false

data/config/rubocop.yml

@@ -96,7 +96,7 @@ SymbolArray:
 
 # Align if/else blocks with the variable assignment
 EndAlignment:
-  AlignWith: variable
+  EnforcedStyleAlignWith: variable
 
 # Do not always align parameters when it is easier to read
 AlignParameters:

data/lib/anima.rb

@@ -1,27 +1,20 @@
-# encoding: utf-8
-
 require 'adamantium'
 require 'equalizer'
 require 'abstract_type'
 
 # Main library namespace and mixin
+# @api private
 class Anima < Module
   include Adamantium::Flat, Equalizer.new(:attributes)
 
   # Return names
   #
   # @return [AttributeSet]
-  #
-  # @api private
-  #
   attr_reader :attributes
 
   # Initialize object
   #
   # @return [undefined]
-  #
-  # @api private
-  #
   def initialize(*names)
     @attributes = names.uniq.map(&Attribute.method(:new)).freeze
   end
@@ -34,8 +27,6 @@ class Anima < Module
   #   anima = Anima.new(:foo)
   #   anima.add(:bar) # equals Anima.new(:foo, :bar)
   #
-  # @api private
-  #
   def add(*names)
     new(attribute_names + names)
   end
@@ -48,8 +39,6 @@ class Anima < Module
   #   anima = Anima.new(:foo, :bar)
   #   anima.remove(:bar) # equals Anima.new(:foo)
   #
-  # @api public
-  #
   def remove(*names)
     new(attribute_names - names)
   end
@@ -59,9 +48,6 @@ class Anima < Module
   # @param [Object] object
   #
   # @return [Hash]
-  #
-  # @api private
-  #
   def attributes_hash(object)
     attributes.each_with_object({}) do |attribute, attributes_hash|
       attributes_hash[attribute.name] = attribute.get(object)
@@ -71,9 +57,6 @@ class Anima < Module
   # Return attribute names
   #
   # @return [Enumerable<Symbol>]
-  #
-  # @api private
-  #
   def attribute_names
     attributes.map(&:name)
   end
@@ -86,9 +69,6 @@ class Anima < Module
   # @param [Hash] attribute_hash
   #
   # @return [self]
-  #
-  # @api private
-  #
   def initialize_instance(object, attribute_hash)
     assert_known_attributes(object.class, attribute_hash)
     attributes.each do |attribute|
@@ -105,14 +85,15 @@ class Anima < Module
     #   a hash that matches anima defined attributes
     #
     # @return [undefined]
-    #
-    # @api public
     def initialize(attributes)
       self.class.anima.initialize_instance(self, attributes)
     end
 
     # Return a hash representation of an anima infected object
     #
+    # @example
+    #   anima.to_h # => { :foo => : bar }
+    #
     # @return [Hash]
     #
     # @api public
@@ -136,8 +117,7 @@ class Anima < Module
     #
     # @return [Anima]
     #
-    # @api private
-    #
+    # @api public
     def with(attributes)
       self.class.new(to_h.update(attributes))
     end
@@ -150,9 +130,6 @@ class Anima < Module
   # @param [Class, Module] scope
   #
   # @return [undefined]
-  #
-  # @api private
-  #
   def included(descendant)
     descendant.instance_exec(self, attribute_names) do |anima, names|
       # Define anima method
@@ -180,15 +157,15 @@ class Anima < Module
   # @return [undefined]
   #
   # @raise [Error]
-  #
-  # @api private
   def assert_known_attributes(klass, attribute_hash)
     keys = attribute_hash.keys
 
     unknown = keys - attribute_names
     missing = attribute_names - keys
 
-    fail Error.new(klass, missing, unknown) if unknown.any? || missing.any?
+    unless unknown.empty? && missing.empty?
+      fail Error.new(klass, missing, unknown)
+    end
   end
 
   # Return new instance
@@ -196,9 +173,6 @@ class Anima < Module
   # @param [Enumerable<Symbol>] attributes
   #
   # @return [Anima]
-  #
-  # @api private
-  #
   def new(attributes)
     self.class.new(*attributes)
   end

data/lib/anima/attribute.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 class Anima
   # An attribute
   class Attribute
@@ -8,9 +6,6 @@ class Anima
     # Initialize attribute
     #
     # @param [Symbol] name
-    #
-    # @api private
-    #
     def initialize(name)
       @name, @instance_variable_name = name, :"@#{name}"
     end
@@ -18,17 +13,11 @@ class Anima
     # Return attribute name
     #
     # @return [Symbol]
-    #
-    # @api private
-    #
     attr_reader :name
 
     # Return instance variable name
     #
     # @return [Symbol]
-    #
-    # @api private
-    #
     attr_reader :instance_variable_name
 
     # Load attribute
@@ -37,9 +26,6 @@ class Anima
     # @param [Hash] attributes
     #
     # @return [self]
-    #
-    # @api private
-    #
     def load(object, attributes)
       set(object, attributes.fetch(name))
     end
@@ -49,9 +35,6 @@ class Anima
     # @param [Object] object
     #
     # @return [Object]
-    #
-    # @api private
-    #
     def get(object)
       object.public_send(name)
     end
@@ -62,9 +45,6 @@ class Anima
     # @param [Object] value
     #
     # @return [self]
-    #
-    # @api private
-    #
     def set(object, value)
       object.instance_variable_set(instance_variable_name, value)
 

data/lib/anima/error.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 class Anima
   # Abstract base class for anima errors
   class Error < RuntimeError
@@ -14,9 +12,6 @@ class Anima
     # @param [Enumerable<Symbol>] unknown
     #
     # @return [undefined]
-    #
-    # @api private
-    #
     def initialize(klass, missing, unknown)
       super(FORMAT % [klass, missing, unknown])
     end

data/spec/integration/simple_spec.rb

@@ -1,7 +1,3 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
 class TestClass
   include Anima.new(:firstname, :lastname)
 end

data/spec/spec_helper.rb

@@ -1,5 +1,2 @@
-# encoding: utf-8
-
 require 'anima'
-require 'devtools'
-Devtools.init_spec_helper
+require 'devtools/spec_helper'

data/spec/unit/anima/attribute_spec.rb

@@ -1,7 +1,3 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
 describe Anima::Attribute do
   let(:object) { described_class.new(:foo) }
 

data/spec/unit/anima/error_spec.rb

@@ -1,7 +1,3 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
 describe Anima::Error do
   describe '#message' do
     let(:object) { described_class.new(Anima, missing, unknown) }

data/spec/unit/anima_spec.rb

@@ -1,7 +1,3 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
 describe Anima do
   let(:object) { described_class.new(:foo) }
 
@@ -132,6 +128,17 @@ describe Anima do
           Anima::Error.new(target.class, [], [:baz]).message
         )
       end
+
+      context 'and the extra key is falsy' do
+        let(:attribute_hash) { { foo: foo, bar: bar, nil => double('Baz') } }
+
+        it 'should raise error' do
+          expect { subject }.to raise_error(
+            Anima::Error,
+            Anima::Error.new(target.class, [], [nil]).message
+          )
+        end
+      end
     end
 
     context 'when a key is missing in attribute hash' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anima
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Markus Schirp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-04 00:00:00.000000000 Z
+date: 2019-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adamantium
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: devtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.23
 description: 
 email: mbj@schirp-dso.com
 executables: []
@@ -59,23 +73,20 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - Changelog.md
 - Gemfile
-- Guardfile
 - README.md
 - Rakefile
-- TODO
 - anima.gemspec
-- circle.yml
 - config/flay.yml
 - config/flog.yml
 - config/mutant.yml
 - config/reek.yml
-- config/roodi.yml
 - config/rubocop.yml
 - config/yardstick.yml
 - lib/anima.rb
@@ -105,8 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Initialize object attributes via attributes hash
@@ -116,4 +126,3 @@ test_files:
 - spec/unit/anima/attribute_spec.rb
 - spec/unit/anima/error_spec.rb
 - spec/unit/anima_spec.rb
-has_rdoc: 

data/Guardfile

@@ -1,18 +0,0 @@
-# encoding: utf-8
-
-guard :bundler do
-  watch('Gemfile')
-end
-
-guard :rspec, :version => 2 do
-  # run all specs if the spec_helper or supporting files files are modified
-  watch('spec/spec_helper.rb')                      { 'spec' }
-  watch(%r{\Aspec/(?:lib|support|shared)/.+\.rb\z}) { 'spec' }
-
-  # run unit specs if associated lib code is modified
-  watch(%r{\Alib/(.+)\.rb\z})                                         { |m| Dir["spec/unit/#{m[1]}"] }
-  watch("lib/#{File.basename(File.expand_path('../', __FILE__))}.rb") { 'spec'                       }
-
-  # run a spec if it is modified
-  watch(%r{\Aspec/(?:unit|integration)/.+_spec\.rb\z})
-end

data/TODO

@@ -1,3 +0,0 @@
-* Use module subclass trick to improve expressiveness of Attribute / AttributeSet / ClassMethod
-* Add ability to freeze attribute_set via dsl
-* Add full unit spec coverage

data/circle.yml

@@ -1,7 +0,0 @@
----
-machine:
-  ruby:
-    version: '2.2'
-test:
-  override:
-    - bundle exec rake ci

data/config/roodi.yml

@@ -1,18 +0,0 @@
----
-AbcMetricMethodCheck:            { score: 11.0 }
-AssignmentInConditionalCheck:    { }
-CaseMissingElseCheck:            { }
-ClassLineCountCheck:             { line_count: 293 }
-ClassNameCheck:                  { pattern: !ruby/regexp '/\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/' }
-ClassVariableCheck:              { }
-CyclomaticComplexityBlockCheck:  { complexity: 2 }
-CyclomaticComplexityMethodCheck: { complexity: 4 }
-EmptyRescueBodyCheck:            { }
-ForLoopCheck:                    { }
-# TODO: decrease line_count to 5 to 10
-MethodLineCountCheck:            { line_count: 14 }
-MethodNameCheck:                 { pattern: !ruby/regexp '/\A(?:[a-z\d](?:_?[a-z\d])+[?!=]?|\[\]=?|==|<=>|[+*&|-])\z/' }
-ModuleLineCountCheck:            { line_count: 295 }
-ModuleNameCheck:                 { pattern: !ruby/regexp '/\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/' }
-# TODO: decrease parameter_count to 2 or less
-ParameterNumberCheck:            { parameter_count: 3 }