entasis 0.3.2 → 0.4.0

data/HISTORY

@@ -1,3 +1,8 @@
+== 0.4.0
+Introduced options for Entasis::Model.attributes and Entasis::TransposeKeys
+It's now possible to silently ignore unknown attributes by passing
+options ignore_undefined: true as last argument when defining attributes.
+
 == 0.3.2
 Do not require attribute hash at initialization (Jack Christensen and Joshua Davey)
 

data/README.md

@@ -18,18 +18,22 @@ class Person
   end
 end
 
-hilda = Person.new(name: 'Hilda', age: '23', city: 'Berlin')
+hilda = Person.new(name: 'Hilda', age: '23', city: 'Stockholm')
 hilda.attribute_names # => ["name", "age", "city"]
-hilda.attributes      # => {"name"=>"Hilda", "age"=>23, "city"=>"Berlin"}
+hilda.attributes      # => {"name"=>"Hilda", "age"=>23, "city"=>"Stockholm"}
 
 anon = Person.new
 anon.valid?           # => false
 anon.errors           # => {:name=>["can't be blank"]}>
 ```
 
+Default behavior is to raise if any key in the hash given to `.new` or `#attributes=` is not defined,
+this can be circumvented by passing `ignore_undefined: true` as options when defining your attributes.
 
 Contributors
 ------------
 
+Ingemar Edsborn (ingemar)
 Joshua Davey (jgdavey)
 Johnny Winn (nurugger07)
+Jack Christensen (jackc)

data/lib/entasis/model.rb

@@ -4,7 +4,8 @@ module Entasis
 
     included do
       include ActiveModel::Validations
-      class_attribute :attribute_names
+      class_attribute :attribute_names, :attributes_config, instance_writer: false
+
       self.attribute_names ||= []
       self.class_eval 'class UnknownAttributeError < StandardError; end'
     end
@@ -12,10 +13,14 @@ module Entasis
     module ClassMethods
       ##
       #
-      # Takes a list of attribute names
+      # Takes a list of attribute names. Last argument can be an options hash.
+      #
+      #   ignore_undefined: true - Silently ignore any undefined attributes
       #
       def attributes(*attrs)
-        self.attribute_names += attrs.map(&:to_s)
+        self.attributes_config = attrs.last.is_a?(Hash) ? attrs.pop : {}
+
+        self.attribute_names += attrs.map(&:to_s).sort
 
         attr_accessor *attrs
       end
@@ -29,33 +34,27 @@ module Entasis
       self.attributes = hash
     end
 
-    ##
-    #
-    # Returns a list of attribute names
-    #
-    def attribute_names
-      self.class.class_variable_get :@@attribute_names
-    end
-
     ##
     #
     # Takes a hash of attribute names and values and set each attribute.
     #
-    # If passwed an unkown attribute it ill raise +class::UnknownAttributeError+
+    # If passwed an unkown attribute it will raise +class::UnknownAttributeError+
     #
     def attributes=(hash)
       hash.each do |name, value|
         if attribute_names.include?(name.to_s) || self.respond_to?("#{name}=")
           self.send("#{name}=", value)
         else
-          raise self.class::UnknownAttributeError, "unkown attribute: #{name}"
+          if attributes_config[:ignore_undefined] != true
+            raise self.class::UnknownAttributeError, "unknown attribute: #{name}"
+          end
         end
       end
     end
 
     ##
     #
-    # Returns all attributes serialied as hash
+    # Returns all attributes serialized as hash
     #
     def attributes
       attribute_names.inject({}) { |h, name| h[name] = send(name); h }

data/lib/entasis/transpose_keys.rb

@@ -0,0 +1,28 @@
+module Entasis
+  module TransposeKeys
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method_chain :attributes=, :transpose
+    end
+
+    ##
+    #
+    # Takes a hash of attribute names and values and set each attribute.
+    #
+    # If passwed an unkown attribute it ill raise +class::UnknownAttributeError+
+    #
+    def attributes_with_transpose=(hash)
+      hash.each do |name, value|
+        transposed_name = name.to_s.dup.underscore.downcase
+        if attribute_names.include?(transposed_name) || self.respond_to?("#{transposed_name}=")
+          self.send("#{transposed_name}=", value)
+        else
+          if attributes_config[:ignore_undefined] != true
+            raise self.class::UnknownAttributeError, "unknown attribute: #{transposed_name} (transposed from #{name})"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/entasis/version.rb

@@ -1,3 +1,3 @@
 module Entasis
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/entasis.rb

@@ -2,6 +2,9 @@ require 'active_support'
 require 'active_model'
 
 module Entasis
-  autoload :Model, 'entasis/model'
-  autoload :Base, 'entasis/base'
+  extend ActiveSupport::Autoload
+
+  autoload :Model
+  autoload :TransposeKeys
+  autoload :Base
 end

data/spec/entasis_spec.rb

@@ -1,57 +1,81 @@
 require 'spec_helper'
 
-describe "Entasis::Model" do
-  let(:hilda) { hilda = Person.new(:name => 'Hilda', :age => '23', :city => 'Berlin') }
-
-  describe "#new" do
-    it "sets the attributes from the given hash" do
-      hilda.name.should == 'Hilda'
-      hilda.age.should  == 23
-      hilda.city.should == 'Berlin'
-    end
+describe Entasis::Model do
+  let(:attributes) do
+    { name: 'Hilda', age: '23', city: 'Stockholm' }
+  end
+  let(:person) { Person.new(attributes) }
 
-    it "raises an error if attribute is unknown" do
-      expect {
-        Person.new(undefined: 'value')
-      }.to raise_error Person::UnknownAttributeError, 'unkown attribute: undefined'
+  describe '#new' do
+    it 'calls #attributes= with the given hash' do
+      Person.any_instance.should_receive(:attributes=).once.with(attributes)
+      person
     end
 
-    it "does not require attribute hash" do
+    it 'does not require attribute hash' do
       expect { Person.new }.to_not raise_error
     end
   end
 
-  describe "#attribute_names" do
+  describe '#attribute_names' do
     it 'returns a list of attribute names' do
-      hilda.attribute_names.should == %w[name age city]
+      expect(person.attribute_names).to eq(%w[name age city].sort)
     end
   end
 
-  describe "#attributes" do
-    it 'returns a hash of attributes names and values' do
-      hilda.attributes.should == {"name"=>"Hilda", "age"=>23, "city"=>"Berlin"}
+  describe '#attributes=' do
+    context 'when given a hash' do
+      it 'sets the attributes from the given hash' do
+        person.attributes = attributes
+
+        expect(person.name).to eq('Hilda')
+        expect(person.age).to eq(23)
+        expect(person.city).to eq('Stockholm')
+      end
+    end
+
+    it 'raises an error if attribute is unknown' do
+      expect {
+        Person.new(undefined: 'value')
+      }.to raise_error Person::UnknownAttributeError, 'unknown attribute: undefined'
+    end
+
+    context 'when .attributes option :allow_unknown is set to true' do
+      subject { RelaxedPerson.new(undefined: 'value') }
+
+      it 'ignores that attribute' do
+        expect(subject.attributes.keys).to_not include('undifined')
+      end
     end
   end
 
-  describe "subclasses" do
-    let(:hans) { Child.new(:name => 'Hans', :age => "8", :candy => true) }
+  describe '#attributes' do
+    it 'returns a hash of attributes names and values' do
+      expect(person.attributes).to eq({ 'name' => 'Hilda', 'age' => 23, 'city' => 'Stockholm' })
+    end
 
-    it "inherits attributes from the parent" do
-      hans.attributes.should == { "name" => "Hans", "age" => 8,  "city" => nil, "candy" => true }
+    context 'subclasses' do
+      let(:child) { Child.new(name: 'Hans', age: '8', candy: true) }
 
+      it 'inherits attributes from the parent' do
+        expect(child.attributes).to eq({ 'name' => 'Hans', 'age' => 8,  'city' => nil, 'candy' => true })
+      end
     end
   end
 
-  context "validations" do
-    describe "#valid?" do
-      it "validates" do
-        hilda.should be_valid
+  context 'validations' do
+    describe '#valid?' do
+      context 'when valid' do
+        it { expect(person).to be_valid }
       end
 
-      it "will have errors" do
-        anon = Person.new(:name => "")
-        anon.should_not be_valid
-        anon.errors.to_hash.should == { :name => ["can't be blank"] }
+      context 'invalid' do
+        subject { Person.new(name: '') }
+
+        it 'will have errors' do
+          expect(subject).to_not be_valid
+          expect(subject.errors.to_hash).to eq({ name: ["can't be blank"] })
+        end
       end
     end
   end

data/spec/spec_helper.rb

@@ -2,7 +2,10 @@ require "rubygems"
 require "bundler/setup"
 
 require 'entasis'
-require File.expand_path(File.dirname(__FILE__) + '/support/person')
+
+Dir.glob(File.dirname(__FILE__) + '/support/**/*.rb').each do |filename|
+  require filename
+end
 
 RSpec.configure do |config|
 end

data/spec/transpose_keys_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Entasis::TransposeKeys do
+  let(:attributes) do
+    { 'Speed' => 200, 'leftFrontDoor' => 'blue', 'RightFront_Door' => 'green' }
+  end
+  let(:car) { Car.new(attributes) }
+
+  describe '#attributes=' do
+    context 'when given a hash' do
+      it 'sets the attributes from the given hash' do
+        car.attributes = attributes
+
+        expect(car.speed).to eq(200)
+        expect(car.left_front_door).to eq('blue')
+        expect(car.right_front_door).to eq('green')
+      end
+    end
+
+    it 'raises an error if attribute is unknown' do
+      expect {
+        Car.new(unDefined: 'value')
+      }.to raise_error Car::UnknownAttributeError, 'unknown attribute: un_defined (transposed from unDefined)'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: entasis
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-11 00:00:00.000000000 Z
+date: 2013-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -53,6 +53,7 @@ extra_rdoc_files: []
 files:
 - lib/entasis/base.rb
 - lib/entasis/model.rb
+- lib/entasis/transpose_keys.rb
 - lib/entasis/version.rb
 - lib/entasis.rb
 - Gemfile
@@ -62,6 +63,7 @@ files:
 - LICENSE
 - spec/entasis_spec.rb
 - spec/spec_helper.rb
+- spec/transpose_keys_spec.rb
 homepage: http://github.com/ingemar/entasis
 licenses: []
 post_install_message: 
@@ -89,3 +91,4 @@ summary: A few neat methods for a basic class
 test_files:
 - spec/entasis_spec.rb
 - spec/spec_helper.rb
+- spec/transpose_keys_spec.rb