attribrutal 0.0.3 → 0.0.4

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+*.DS_Store
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tags

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    attribrutal (0.0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  attribrutal!
+  bundler
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jens Norrgrann
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+Attribrutal
+============
+
+Lazily coerced attributes
+
+##Usage:
+
+    class MoreSpeed
+      include Attribrutal::Model
+      attribute :harder
+      attribute :better
+      attribute :faster
+      attribute :stronger
+    end
+
+##With coercion:
+
+    class MoreSpeed
+      include Attribrutal::Model
+      attribute :harder, Coercion::Integer
+      attribute :better, Coercion::String
+      attribute :faster, Coercion::Boolean
+      attribute :stronger, MyAwesomeCoercion
+    end
+
+##With defaults:
+
+    class MoreSpeed
+      include Attribrutal::Model
+      attribute :harder, Coercion::Integer, default: 10
+      attribute :better, Coercion::String, default: "better"
+      attribute :faster, Coercion::Boolean, default: true
+      attribute :stronger, MyAwesomeCoercion
+    end
+
+##Introspection
+
+`MoreSpeed.attributes` return a hash of attribute names and their types
+
+##Assignment
+
+`MoreSpeed.new harder: 30, better: "much"`
+
+##Getting at raw (uncoerced) attributes
+
+`MoreSpeed.new.raw_attributes`
+
+##Getting at coerced attributes
+
+`MoreSpeed.new.attributes`
+
+##Coercers
+
+Implement your own, they should provide a class method `coerce` which
+takes two arguments; a value and a default and return the value
+coerced or the default, its all up to the coercer. You can implement
+any kind of additional meta information on the type.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/attribrutal.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attribrutal/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'attribrutal'
+  spec.version     = Attribrutal::VERSION
+  spec.date        = '2014-03-17'
+  spec.summary     = "Lazy attribute coercion"
+  spec.description = ""
+  spec.authors     = ["Bukowskis"]
+  spec.email       = ''
+  spec.homepage    = ''
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files`.split($/) - ['.travis.yml']
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency('bundler')
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec')
+end

data/lib/attribrutal/coercion.rb

@@ -0,0 +1,33 @@
+module Coercer
+
+  class Boolean
+    def self.coerce(arg, default = nil)
+      if arg == true
+        true
+      else
+        false
+      end
+    end
+  end
+
+  class Integer
+    def self.coerce(arg, default = nil)
+      if arg.nil?
+        default
+      else
+        Integer(arg)
+      end
+    end
+  end
+
+  class String
+    def self.coerce(arg, default = nil)
+      if arg.nil?
+        default
+      else
+        String(arg)
+      end
+    end
+  end
+
+end

data/lib/attribrutal/model.rb

@@ -0,0 +1,58 @@
+module Attribrutal
+
+  module Model
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def initialize( attrs = {} )
+      @attributes = attrs
+    end
+
+    def raw_attributes
+      self.class.instance_variable_get("@attributes").keys.inject(Hash.new) do |attributes, attribute|
+        attributes[attribute] = @attributes[attribute]
+        attributes
+      end
+    end
+
+    def attributes
+      self.class.instance_variable_get("@attributes").keys.inject(Hash.new) do |attributes, attribute|
+        attributes[attribute] = self.send(attribute)
+        attributes
+      end
+    end
+
+    module ClassMethods
+
+      def attribute (sym, coercer=nil, attrs = {})
+
+        define_method(sym) do
+          if coercer
+            coercer.send(:coerce, @attributes[sym], attrs[:default])
+          else
+            @attributes[sym] || default
+          end
+        end
+
+        define_method("#{sym}=".to_sym) do |value|
+          @attributes[sym] = value
+        end
+
+        if @attributes
+          @attributes.merge!({ sym => coercer })
+        else
+          @attributes = { sym => coercer }
+        end
+      end
+
+      def attributes
+        @attributes
+      end
+
+    end
+
+  end
+
+end

data/lib/attribrutal/version.rb

@@ -0,0 +1,3 @@
+module Attribrutal
+  VERSION = "0.0.4"
+end

data/lib/attribrutal.rb

@@ -0,0 +1,6 @@
+require "attribrutal/version"
+require "attribrutal/model.rb"
+require "attribrutal/coercion.rb"
+
+module Attribrutal
+end

data/spec/attribrutal_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+
+describe "Attribrutal#attributes" do
+
+  let (:bar) { Bar.new foo: nil, bar: 10, baz: { alpha: 10, beta: "20" } }
+  let (:bar_with_defaults) { Bar.new }
+
+  it "records defined attributes" do
+    Bar.attributes.keys.should == [:foo, :bar, :baz]
+  end
+
+  it "records defined attribute types" do
+    Bar.attributes.values.should == [Coercer::Boolean, Coercer::String, Coercer::Baz]
+  end
+
+  it "supports mass assignment" do
+    bar.raw_attributes.values.should == [nil, 10, { alpha: 10, beta: "20" }]
+    bar.attributes[:foo].should == false
+    bar.attributes[:bar].should == "10"
+    bar.attributes[:baz].alpha.should == 10
+    bar.attributes[:baz].beta.should == 20
+  end
+
+  it "performs coercion" do
+    attributes = bar.attributes
+    attributes[:foo].should == false
+    attributes[:bar].should == "10"
+  end
+
+  it "supports recursive coercion" do
+    attributes = bar.attributes
+    attributes[:baz].alpha.should == 10
+    attributes[:baz].beta.should == 20
+  end
+
+  it "supports defaults" do
+    bar_with_defaults.bar.should == "bar"
+    bar_with_defaults.baz.class.should == Baz
+    bar_with_defaults.baz.alpha.should == 50
+    bar_with_defaults.baz.beta.should == 100
+  end
+
+  it "is fast enough" do
+    initialization_time = 1000 * Benchmark.realtime do
+      10_000.times { Bar.new }
+    end
+    initialization_time.should < 5
+
+    coercion_time = 1000 * Benchmark.realtime do
+      10_000.times { Bar.new foo: nil, bar: 10, baz: { alpha: "1", beta: "2" } }
+    end
+    coercion_time.should < 50
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path('../support/models', __FILE__)
+
+require 'attribrutal'
+require 'benchmark'
+
+require 'coercer'
+require 'baz'
+require 'bar'

data/spec/support/models/bar.rb

@@ -0,0 +1,6 @@
+class Bar
+  include Attribrutal::Model
+  attribute :foo, Coercer::Boolean
+  attribute :bar, Coercer::String, default: "bar"
+  attribute :baz, Coercer::Baz, default: lambda { ::Baz.new alpha: 50, beta: 100 }
+end

data/spec/support/models/baz.rb

@@ -0,0 +1,5 @@
+class Baz
+  include Attribrutal::Model
+  attribute :alpha, Coercer::Integer, default: 1
+  attribute :beta, Coercer::Integer, default: 2
+end

data/spec/support/models/coercer.rb

@@ -0,0 +1,13 @@
+module Coercer
+
+  class Baz
+    def self.coerce(arg, default = nil)
+      if arg.nil?
+        default.lambda? ? default.call : default
+      else
+        ::Baz.new(arg)
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attribrutal
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -64,7 +64,23 @@ email: ''
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- attribrutal.gemspec
+- lib/attribrutal.rb
+- lib/attribrutal/coercion.rb
+- lib/attribrutal/model.rb
+- lib/attribrutal/version.rb
+- spec/attribrutal_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/bar.rb
+- spec/support/models/baz.rb
+- spec/support/models/coercer.rb
 homepage: ''
 licenses:
 - MIT
@@ -80,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1455837332816569125
+      hash: 1547668724170686462
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -89,11 +105,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1455837332816569125
+      hash: 1547668724170686462
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Lazy attribute coercion
-test_files: []
+test_files:
+- spec/attribrutal_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/bar.rb
+- spec/support/models/baz.rb
+- spec/support/models/coercer.rb