ephemeral 0.1.0

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem "activesupport"
+
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "bundler"
+  gem "rspec"
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.7)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.4)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Corey Ehmke
+
+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,63 @@
+ephemeral
+=========
+
+Ephemeral was created at Trunk Club to bring ORM-like functionality to non-persisted objects. The anticipated use case is for an application that consumes an API and materializes one or more collections of objects from a JSON response or XML response.
+
+Please note that Ephemeral is currently in beta and is probably not ready for production use.
+
+Example the First
+=================
+
+Let's say that we have an API server that stores information about the inventions of Nikola Tesla. We have another application that consumes this information. Our initial call to the API retrieves a list of all of his inventions, but we want to display them in categories. Assuming that we materialize each invention into an Invention object, the Ephemeral wiring is simple. Here's our sample Invention class:
+
+    class Invention
+
+      include Ephemeral::Base
+
+      attr_accessor :name, :description, :category, :stolen_by_edison
+
+      scope :telegraphy,    {:category => 'Telegraphy'}
+      scope :electrical,    {:category => 'Electrical'}
+      scope :mechanical,    {:category => 'Mechanical'}
+      scope :stolen         {:stolen_by_edison => true }
+
+      def initialize(args={})
+        # Marshal object based on your API
+      end
+
+    end
+
+We can now easily find all of Tesla's telegraphy inventions that were shamelessly stolen by Thomas Edison:
+
+    Invention.telegraphy.stolen
+
+Example the Second
+==================
+
+Our Tesla site has really taken off, and now we want to introduce another object, each instance of which represents a period in Tesla's life. We want to associate inventions with each of these periods. Again, rather than building complex logic into our API request, we can simply fetch a mass of data and build our relationships on the consumer application side using Ephemeral:
+
+    class Period
+
+      include Ephemeral::Base
+
+      attr_accessor :name, :start_year, :end_year
+
+      collects :inventions
+
+      def initialize(args={})
+        # Marshal object based on your API, including setting up Invention objects
+      end
+
+    end
+
+Now we can filter inventions on the consumer side:
+
+    period = Period.where(:name => 'Early Years')
+    inventions = period.inventions.mechanical
+    favorite = inventions.where(:name => 'Doomsday Device')
+
+More Examples?
+==============
+
+For a more complete example, please refer to the specs.
+

data/Rakefile

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ephemeral"
+  gem.homepage = "http://github.com/Bantik/ephemeral"
+  gem.license = "MIT"
+  gem.summary = %Q{Ephemeral is an ODM for in-memory collections of objects.}
+  gem.description = %Q{Ephemeral lets you define one-to-many relationships between in-memory objects, with ORM-like support for where clauses and chainable scopes.}
+  gem.email = "corey@idolhands.com"
+  gem.authors = ["Corey Ehmke"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ephemeral #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/ephemeral.rb

@@ -0,0 +1,4 @@
+module Ephemeral
+  require 'ephemeral/base'
+  require 'ephemeral/collection'
+end

data/lib/ephemeral/base.rb

@@ -0,0 +1,38 @@
+module Ephemeral
+
+  module Base
+
+    require 'active_support/core_ext/object/blank'
+    require 'active_support/core_ext/string/inflections'
+
+    def self.included(base)
+      base.extend ClassMethods
+      base.send(:attr_accessor, :collection)
+    end
+
+    module ClassMethods
+
+      def collects(name, args={})
+        class_name = args[:class_name] || name.to_s.classify
+        self.send :define_method, name do
+          self.collection ||= Ephemeral::Collection.new(class_name)
+        end
+        self.send :define_method, "#{name}=" do |objects|
+          self.collection = Ephemeral::Collection.new(class_name, objects)
+        end
+      end
+
+      def scope(name, conditions)
+        self.scopes ||= {}
+        self.scopes[name] = conditions
+      end
+
+      def scopes
+        @@scopes ||= {}
+      end
+
+    end
+
+  end
+
+end

data/lib/ephemeral/collection.rb

@@ -0,0 +1,49 @@
+module Ephemeral
+
+  class Collection
+
+    include Enumerable
+
+    attr_accessor :objects, :klass
+
+    def initialize(klass, objects=[])
+      self.klass = eval(klass)
+      self.klass.scopes.each{ |k, v| define_singleton_method k, lambda { self.execute_scope(k)} }
+      self.objects = self.materialize(objects)
+      self
+    end
+
+    def each(&block)
+      self.objects && self.objects.each(&block)
+    end
+
+    def where(args={})
+      return [] unless self.objects
+      results = args.inject([]){|a,kv| a << self.objects.select{|o| o.send(kv[0]) == kv[1]}}
+      results = results.flatten.select{|r| results.flatten.count(r) == results.count}.uniq
+    end
+
+    def last
+      self.objects.last
+    end
+
+    def materialize(objects_array=[])
+      return [] unless objects_array
+      return objects_array if objects_array.first.class == self.klass
+      objects_array.map{|t| self.klass.new(t) }
+    end
+
+    def execute_scope(method)
+      return Ephemeral::Collection.new(self.klass.name) unless self.objects
+      results = self.klass.scopes[method].inject([]){|a,kv| a << self.objects.select{|o| o.send(kv[0]) == kv[1]}}
+      results = results.flatten.select{|r| results.flatten.count(r) == results.count}.uniq
+      Ephemeral::Collection.new(self.klass.name, results)
+    end
+
+    def << (objekts)
+      self.objects += objekts
+    end
+
+  end
+
+end

data/spec/ephemeral_spec.rb

@@ -0,0 +1,104 @@
+require 'ephemeral'
+
+class Collectible
+  include Ephemeral::Base
+  attr_accessor :name, :item_count
+  scope :foos,      {:name => 'foo'}
+  scope :paychecks, {:name => 'Paychecks'}
+  scope :threes,    {:item_count => 3}
+  def initialize(args={}); args.each{|k,v| self.send("#{k}=", v)}; end
+end
+
+class NotCollectible
+  include Ephemeral::Base
+  attr_accessor :name
+  def initialize(args={}); args.each{|k,v| self.send("#{k}=", v)}; end
+end
+
+class Collector
+  include Ephemeral::Base
+  attr_accessor :name
+  collects :collectibles
+  collects :junk, :class_name => 'NotCollectible'
+  def initialize(args={}); args.each{|k,v| self.send("#{k}=", v)}; end
+end
+
+describe Ephemeral do
+
+  context 'class methods' do
+
+    it 'defines a collection' do
+      Collector.new.collectibles.klass.should == Collectible
+    end
+
+    it 'accepts a class name' do
+      Collector.new.junk.klass.should == NotCollectible
+    end
+
+    it 'creates a setter' do
+      Collector.new.respond_to?(:collectibles=).should be_true
+    end
+
+    it 'creates a getter' do
+      Collector.new.respond_to?(:collectibles).should be_true
+    end
+
+    it 'registers a scope' do
+      Collectible.scopes.include?(:foos).should be_true
+    end
+
+  end
+
+  context 'instance methods' do
+
+    before :each do
+
+      @collectibles = [
+        Collectible.new(:name => 'Paychecks', :item_count => 1),
+        Collectible.new(:name => 'Paychecks', :item_count => 3),
+        Collectible.new(:name => 'Requisitions', :item_count => 2),
+      ]
+
+      @collector = Collector.new(:name => 'Hermes')
+      @collector.collectibles = @collectibles
+
+    end
+
+    describe 'initializes with materialized objects' do
+
+      it 'from a setter' do
+        collector = Collector.new(
+          :name => 'from_api',
+          'collectibles' => [
+            {'name' => 'foo'},
+            {'name' => 'bar'}
+          ]
+        )
+        collector.collectibles.count.should == 2
+      end
+
+    end
+
+    it 'performs a where' do
+      @collector.collectibles.where(:name => 'Paychecks').should_not be_blank
+    end
+
+    describe 'scope method' do
+
+      it 'executes a scope' do
+        @collector.collectibles.paychecks.first.should_not be_nil
+      end
+
+      it 'returns a collection' do
+        @collector.collectibles.paychecks.class.name.should == 'Ephemeral::Collection'
+      end
+
+      it 'chains scopes' do
+        @collector.collectibles.paychecks.threes.count.should == 1
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: ephemeral
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Corey Ehmke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-12 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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: Ephemeral lets you define one-to-many relationships between in-memory
+  objects, with ORM-like support for where clauses and chainable scopes.
+email: corey@idolhands.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/ephemeral.rb
+- lib/ephemeral/base.rb
+- lib/ephemeral/collection.rb
+- spec/ephemeral_spec.rb
+homepage: http://github.com/Bantik/ephemeral
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1888990476814131903
+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: Ephemeral is an ODM for in-memory collections of objects.
+test_files: []