attribute_extensions 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in attribute_extensions.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Delwyn de Villiers
+
+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,29 @@
+# AttributeExtensions
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'attribute_extensions'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attribute_extensions
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/attribute_extensions.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attribute_extensions/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "attribute_extensions"
+  gem.version       = AttributeExtensions::VERSION
+  gem.authors       = ["Delwyn de Villiers"]
+  gem.email         = ["delwyn.d@gmail.com"]
+  gem.description   = %q[Attribute Extenstions]
+  gem.summary       = %q[Define attributes with default values and typecasting]
+  gem.homepage      = "https://github.com/delwyn/attribute_extensions"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'activesupport', '~> 3.2.0'
+
+  gem.add_development_dependency 'rspec', '~> 2.12.0'
+end

data/lib/attribute_extensions.rb

@@ -0,0 +1,33 @@
+require 'active_support/core_ext'
+
+require 'attribute_extensions/typecasting'
+require 'attribute_extensions/version'
+
+module AttributeExtensions
+
+  def self.included(base)
+    base.send(:extend, ClassMethods)
+  end
+
+  module ClassMethods
+    include Typecasting
+
+    def attribute_reader(name, options={})
+      define_method(name.to_sym) do
+        instance_variable_set("@#{name}", options[:default]) unless instance_variable_defined?("@#{name}")
+        instance_variable_get("@#{name}")
+      end
+    end
+
+    def attribute_writer(name, options={})
+      define_method("#{name}=") do |value|
+        instance_variable_set("@#{name}", self.class.typecast(value, options[:type]))
+      end
+    end
+
+    def attribute(name, options={})
+      attribute_reader(name, options)
+      attribute_writer(name, options)
+    end
+  end
+end

data/lib/attribute_extensions/typecasting.rb

@@ -0,0 +1,22 @@
+require 'attribute_extensions/typecasting/boolean_typecaster'
+require 'attribute_extensions/typecasting/default_typecaster'
+require 'attribute_extensions/typecasting/integer_typecaster'
+require 'attribute_extensions/typecasting/symbol_typecaster'
+
+module AttributeExtensions
+  module Typecasting
+
+    def typecast(value, type)
+      if type.respond_to?(:call)
+        type.call(value)
+      else
+        typecaster_for(type).call(value)
+      end
+    end
+
+    def typecaster_for(type)
+      type = :default if type.nil?
+      "AttributeExtensions::Typecasting::#{type.to_s.camelize}Typecaster".constantize.new
+    end
+  end
+end

data/lib/attribute_extensions/typecasting/boolean_typecaster.rb

@@ -0,0 +1,15 @@
+module AttributeExtensions
+  module Typecasting
+    class BooleanTypecaster
+      TRUE_VALUES = [true, 1, "1", "t", "T", "true", "TRUE", "on", "ON"]
+
+      def call(value)
+        if value.is_a?(String) && value !~ /[^[:space:]]/
+          nil
+        else
+          TRUE_VALUES.include?(value)
+        end
+      end
+    end
+  end
+end

data/lib/attribute_extensions/typecasting/default_typecaster.rb

@@ -0,0 +1,9 @@
+module AttributeExtensions
+  module Typecasting
+    class DefaultTypecaster
+      def call(value)
+        value
+      end
+    end
+  end
+end

data/lib/attribute_extensions/typecasting/integer_typecaster.rb

@@ -0,0 +1,9 @@
+module AttributeExtensions
+  module Typecasting
+    class IntegerTypecaster
+      def call(value)
+        value.to_i if value.respond_to?(:to_i)
+      end
+    end
+  end
+end

data/lib/attribute_extensions/typecasting/symbol_typecaster.rb

@@ -0,0 +1,9 @@
+module AttributeExtensions
+  module Typecasting
+    class SymbolTypecaster
+      def call(value)
+        value.to_sym if value.respond_to?(:to_sym)
+      end
+    end
+  end
+end

data/lib/attribute_extensions/version.rb

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

data/spec/attribute_extensions_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe AttributeExtensions do
+  subject { model.new }
+
+  describe 'attribute_reader' do
+    let(:model) {
+      Class.new do
+        include AttributeExtensions
+
+        attribute_reader :color
+        attribute_reader :make, default: nil
+        attribute_reader :gears,  default: 5
+        attribute_reader :diesel, default: false
+        attribute_reader :petrol, default: true
+      end
+    }
+
+    its(:color)  { should eq nil}
+    its(:make)   { should eq nil}
+    its(:gears)  { should eq 5 }
+    its(:diesel) { should be_false }
+    its(:petrol) { should be_true }
+  end
+
+  describe 'attribute_writer' do
+    let(:model) {
+      Class.new do
+        include AttributeExtensions
+
+        attribute_writer :color
+        attribute_writer :make,   type: :symbol
+        attribute_writer :doors,  type: :integer
+        attribute_writer :diesel, type: :boolean
+        attribute_writer :tires,  type: Proc.new { |value| "proc: #{value}" }
+
+        attr_reader :color, :make, :doors, :tires, :diesel
+      end
+    }
+
+    it 'calls typecast with the value and type' do
+      subject.class.should_receive(:typecast).with(1, :integer)
+      subject.doors = 1
+    end
+
+    context 'integer' do
+      before { subject.doors = '4' }
+
+      its(:doors) { should eq 4 }
+    end
+
+    context 'symbol' do
+      before { subject.make = 'audi' }
+
+      its(:make) { should eq :audi }
+    end
+
+    context 'proc' do
+      before { subject.tires = 'tires' }
+
+      its(:tires) { should eq "proc: tires"}
+    end
+
+    context 'without type' do
+      before { subject.color = 'blue' }
+
+      its(:color) { should eq 'blue' }
+    end
+
+    describe 'boolean' do
+      context 'when truthy' do
+        before { subject.diesel = 't' }
+        its(:diesel) { should be_true }
+      end
+
+      context 'when falsy' do
+        before { subject.diesel = 'f' }
+        its(:diesel) { should be_false }
+      end
+    end
+  end
+
+  describe 'attribute' do
+    let(:model) {
+      Class.new do
+        include AttributeExtensions
+      end
+    }
+
+    it 'creates a reader and a writer' do
+      options = { type: :integer, default: 1 }
+      model.should_receive(:attribute_reader).with(:name, options)
+      model.should_receive(:attribute_writer).with(:name, options)
+      model.send(:attribute, :name, options)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'attribute_extensions'
+
+root = File.expand_path('../../', __FILE__)
+
+Dir["#{root}/spec/support/**/*.rb"].each { |file| require file }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

data/spec/support/models.rb

@@ -0,0 +1,19 @@
+class Car
+  include AttributeExtensions
+
+  # Attributes
+  attribute :color
+  attribute :automatic,  type: :boolean
+  attribute :tires,      type: Proc.new { |value| "proc: #{value}" }
+
+  # Attribute Readers
+  attribute_reader :gears,  default: 5
+  attribute_reader :diesel, default: false
+  attribute_reader :petrol, default: true
+
+  # Attribute Writers
+  attribute_writer :doors,      type: :integer
+  attribute_writer :make,       type: :symbol
+
+  attr_reader :doors, :make
+end

data/spec/typecasting/boolean_typecaster_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe AttributeExtensions::Typecasting::BooleanTypecaster do
+  it 'returns nil when blank string' do
+    subject.call('').should be_nil
+  end
+
+  it 'returns false when value is not in TRUE_VALUES' do
+    subject.call('falsy').should be_false
+  end
+
+  it 'returns true when value is in TRUE_VALUES' do
+    expect{
+      stub_const("AttributeExtensions::Typecasting::BooleanTypecaster::TRUE_VALUES", ['truthy'])
+    }.to change{ subject.call('truthy') }.from(false).to(true)
+  end
+end

data/spec/typecasting/default_typecaster_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe AttributeExtensions::Typecasting::DefaultTypecaster do
+  it 'returns the value' do
+    subject.call('value').should eq 'value'
+  end
+end

data/spec/typecasting/integer_typecaster_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe AttributeExtensions::Typecasting::IntegerTypecaster do
+  it 'returns the value.to_i if value responds to :to_i' do
+    subject.call('1').should eq 1
+  end
+
+  it 'returns nil if value does not respond to :to_i' do
+    subject.call(true).should be_nil
+  end
+end

data/spec/typecasting/symbol_typecaster_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe AttributeExtensions::Typecasting::SymbolTypecaster do
+  it 'returns the value.to_sym if value responds to :to_sym' do
+    subject.call('sym').should eq :sym
+  end
+
+  it 'returns nil if value does not respond to :to_sym' do
+    subject.call(true).should be_nil
+  end
+end

data/spec/typecasting_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe AttributeExtensions::Typecasting do
+  let(:model) {
+    Class.new do
+      include AttributeExtensions
+    end
+  }
+
+  describe 'typecast' do
+    context 'when type responds_to :call' do
+      it 'sends :call with the value to the type' do
+        proc = double
+        proc.stub(:call).with(1).and_return 'some value'
+        model.send(:typecast, 1, proc).should eq 'some value'
+      end
+    end
+
+    context 'when type does not respond to call' do
+      let(:typecaster) { AttributeExtensions::Typecasting::IntegerTypecaster.new }
+
+      it 'sends :call with the value to the typecaster' do
+        typecaster.should_receive(:call).with('1')
+        model.should_receive(:typecaster_for).with(:boolean).and_return(typecaster)
+        model.send(:typecast, '1', :boolean)
+      end
+    end
+  end
+
+  describe 'typecaster_for' do
+    it 'returns a new instance of DefaultTypecaster when type is nil' do
+      model.typecaster_for(nil).should be_an_instance_of(AttributeExtensions::Typecasting::DefaultTypecaster)
+    end
+
+    it 'returns a new instance of Typecaster that matches the type' do
+      class AttributeExtensions::Typecasting::SomeTypeTypecaster; end
+
+      model.typecaster_for(:some_type).should be_an_instance_of(AttributeExtensions::Typecasting::SomeTypeTypecaster)
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: attribute_extensions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Delwyn de Villiers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: Attribute Extenstions
+email:
+- delwyn.d@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- attribute_extensions.gemspec
+- lib/attribute_extensions.rb
+- lib/attribute_extensions/typecasting.rb
+- lib/attribute_extensions/typecasting/boolean_typecaster.rb
+- lib/attribute_extensions/typecasting/default_typecaster.rb
+- lib/attribute_extensions/typecasting/integer_typecaster.rb
+- lib/attribute_extensions/typecasting/symbol_typecaster.rb
+- lib/attribute_extensions/version.rb
+- spec/attribute_extensions_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/typecasting/boolean_typecaster_spec.rb
+- spec/typecasting/default_typecaster_spec.rb
+- spec/typecasting/integer_typecaster_spec.rb
+- spec/typecasting/symbol_typecaster_spec.rb
+- spec/typecasting_spec.rb
+homepage: https://github.com/delwyn/attribute_extensions
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Define attributes with default values and typecasting
+test_files:
+- spec/attribute_extensions_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/typecasting/boolean_typecaster_spec.rb
+- spec/typecasting/default_typecaster_spec.rb
+- spec/typecasting/integer_typecaster_spec.rb
+- spec/typecasting/symbol_typecaster_spec.rb
+- spec/typecasting_spec.rb