hashie-lazy_trash 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 documentation

data/.simplecov

@@ -0,0 +1 @@
+SimpleCov.start

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'simplecov', :require => false
+gem 'rspec'
+gem 'hashie', :github => 'intridea/hashie'
+gem 'guard-rspec'

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Christoph Olszowka
+
+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,30 @@
+# Hashie::LazyTrash
+
+An extended `Hashie::Trash` with the following 2 additional features:
+
+  1. When trying to set a value that is not defined as a property, the LazyTrash just sllently ignores this value
+     (as opposed to Hashie::Trash, which raises an Exception)
+
+  2. You can define properties that are to be fetched lazily (on first access), i.e.
+
+        property :user_id
+        property :user, :lazy => lambda { User.find(user_id) }
+
+     As you can see in this example, the Proc is executed in the context of the Hashie::LazyTrash instance
+
+## Usage
+
+This gem relies on the yet-unreleased version 2 of the `hashie` gem. Therefore, you must get that dependency using bundler
+from github manually for now:
+
+    # Gemfile
+    gem 'hashie', :github => 'intridea/hashie'
+    gem 'hashie-lazy_trash'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/hashie-lazy_trash.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hashie-lazy_trash/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Christoph Olszowka"]
+  gem.email         = ["christoph at olszowka.de"]
+  gem.description   = %q{An extended version of Hashie::Trash}
+  gem.summary       = %q{An extended version of Hashie::Trash}
+  gem.homepage      = "https://github.com/colszowka/hashie-lazy_trash"
+
+  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.name          = "hashie-lazy_trash"
+  gem.require_paths = ["lib"]
+  gem.version       = HashieLazyTrashVersion
+end

data/lib/hashie-lazy_trash.rb

@@ -0,0 +1,43 @@
+require "hashie-lazy_trash/version"
+require 'hashie'
+
+#
+# A Hashie::Trash with 2 main differences:
+#
+#   1. When trying to set a value that is not defined as a property, the LazyTrash just sllently ignores this value
+#      (as opposed to Hashie::Trash, which raises an Exception)
+#   2. You can define properties that are to be fetched lazily (on first access), i.e.
+#
+#        property :user_id
+#        property :user, lazy: ->{ User.find(user_id) }
+#
+#      As you can see in this example, the Proc is executed in the context of the Hashie::LazyTrash instance.
+#
+class Hashie::LazyTrash < Hashie::Trash
+  def self.property(property_name, options = {})
+    super
+
+    if options[:lazy]
+      lazy_properties[property_name.to_sym] = options[:lazy]
+    end
+  end
+
+  def [](property)
+    if !super and self.class.lazy_properties.include?(property.to_sym)
+      self[property.to_sym] = instance_exec(&self.class.lazy_properties[property.to_sym])
+    else
+      super
+    end
+  end
+
+  private
+
+  def self.lazy_properties
+    @lazy_properties ||= {}
+  end
+
+  # If the property does not exist, just returns false and therefore denies setting a value to it
+  def property_exists?(property)
+    self.class.property?(property.to_sym)
+  end
+end

data/lib/hashie-lazy_trash/version.rb

@@ -0,0 +1 @@
+HashieLazyTrashVersion = '0.0.1'

data/spec/lazy_trash_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Hashie::LazyTrash do
+  class ExampleTrash < Hashie::LazyTrash
+    User = ""
+    property :name
+    property :email, :transform_with => lambda { |val| val.downcase }
+    property :created_at, :from => :time, :with => lambda { |t| Time.parse(t) }
+    property :user, :lazy => lambda { User.find_by_name(name) }
+  end
+
+  it "accepts a name" do
+    ExampleTrash.new(:name => 'Christoph').name.should == 'Christoph'
+    ExampleTrash.new("name" => 'Christoph').name.should == 'Christoph'
+  end
+
+  it "accepts an email and downcases it" do
+    ExampleTrash.new(:email => 'Christoph@Example.com').email.should == 'christoph@example.com'
+  end
+
+  it "accepts a Time string and parses it" do
+    time = Time.now
+    ExampleTrash.new(:time => time.iso8601).created_at.to_i.should == time.to_i
+  end
+
+  it "allows to set created_at directly" do
+    time = Time.now
+    ExampleTrash.new(:created_at => time).created_at.should == time
+  end
+
+  it "silently ignores undefined properties" do
+    lazy_trash = ExampleTrash.new(:undefined => 'foo')
+    expect { lazy_trash.undefined }.to raise_error(NoMethodError)
+  end
+
+  it "evaluates lazy attributes on first access and caches them" do
+    ExampleTrash::User.should_receive(:find_by_name).with('Christoph').once.and_return('A User object')
+    lazy_trash = ExampleTrash.new(:name => 'Christoph')
+    lazy_trash.user.should == 'A User object'
+    lazy_trash.user.should == 'A User object'
+  end
+
+  it "allows to set lazy attributes explicitly" do
+    ExampleTrash::User.should_not_receive(:find_by_name)
+    lazy_trash = ExampleTrash.new(:user => 'A user')
+    lazy_trash.user.should == 'A user'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'simplecov'
+require 'bundler/setup'
+require 'hashie-lazy_trash'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: hashie-lazy_trash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christoph Olszowka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-14 00:00:00.000000000 Z
+dependencies: []
+description: An extended version of Hashie::Trash
+email:
+- christoph at olszowka.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .simplecov
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- hashie-lazy_trash.gemspec
+- lib/hashie-lazy_trash.rb
+- lib/hashie-lazy_trash/version.rb
+- spec/lazy_trash_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/colszowka/hashie-lazy_trash
+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: An extended version of Hashie::Trash
+test_files:
+- spec/lazy_trash_spec.rb
+- spec/spec_helper.rb