fauxsql 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Collin Miller
+
+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.rdoc

@@ -0,0 +1,44 @@
+= fauxsql
+
+It's a little api for DataMapper records.
+
+    class FauxSqlObject
+      include DataMapper::Resource
+      include Fauxsql
+      
+      property :id, Serial
+    end
+    
+Fauxsql adds its own property.
+
+    property :fauxsql_attributes, Object
+
+To specify the specific fauxsql attributes use this api:
+
+    attribute :secret_power
+
+If you want to have an attribute that is an Array or a Hash, use these:
+
+    list :awesome_things
+    map :dictionary
+
+That's the basics. Under the hood most of the serializing/deserializing
+is left up to DataMapper. However, Fauxsql steps in for special cases.
+
+Right now the only special case is when you set a DataMapper record as an 
+attribute, member of a list, key in a map, or a value in a map. In this case
+Fauxsql transparently wraps the record in a DereferencedAttribute class.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Collin Miller. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fauxsql"
+    gem.summary = %Q{This is summary}
+    gem.description = %Q{And description}
+    gem.email = "collintmiller@gmail.com"
+    gem.homepage = "http://github.com/collin/fauxsql"
+    gem.authors = ["Collin Miller"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_dependency "datamapper"
+    gem.add_dependency "do_sqlite3"
+    gem.add_dependency "activesupport", ">= 3.0.pre"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fauxsql #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/fauxsql.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fauxsql}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Collin Miller"]
+  s.date = %q{2010-04-20}
+  s.description = %q{And description}
+  s.email = %q{collintmiller@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "fauxsql.gemspec",
+     "lib/fauxsql.rb",
+     "lib/fauxsql/attribute.rb",
+     "lib/fauxsql/attribute_list.rb",
+     "lib/fauxsql/attribute_map.rb",
+     "lib/fauxsql/dereferenced_attribute.rb",
+     "lib/fauxsql/dsl.rb",
+     "test/helper.rb",
+     "test/test_fauxsql.rb"
+  ]
+  s.homepage = %q{http://github.com/collin/fauxsql}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{This is summary}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_fauxsql.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<datamapper>, [">= 0"])
+      s.add_runtime_dependency(%q<do_sqlite3>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.pre"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<datamapper>, [">= 0"])
+      s.add_dependency(%q<do_sqlite3>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.pre"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<datamapper>, [">= 0"])
+    s.add_dependency(%q<do_sqlite3>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.pre"])
+  end
+end
+

data/lib/fauxsql/attribute.rb

@@ -0,0 +1,10 @@
+module Fauxsql
+  # Attribute is a mixin for AttributeList and AttributeMap classes.
+  # It should be mixed into classes that inherit standard Ruby data structures
+  module Attribute
+    def initialize(record, name)
+      super() # explicitly super without arguments to preserve base behavior
+      record.fauxsql_attributes[name] = self
+    end
+  end
+end

data/lib/fauxsql/attribute_list.rb

@@ -0,0 +1,35 @@
+module Fauxsql
+  # AttributeList is an Array that dereferences and resolves fauxsql attributes
+  # when setting/reading members in the Array
+  class AttributeList < Array
+    include Attribute
+    
+    def <<(attribute)
+      super Fauxsql.dereference_fauxsql_attribute(attribute)
+    end
+    
+    def [] index
+      Fauxsql.resolve_fauxsql_attribute super(index)
+    end
+    
+    def first
+      self[0]
+    end
+    
+    def last
+      self[length - 1]
+    end
+        
+    def equals list
+      map_resolved == list
+    end
+    
+    def map_resolved
+      map = []
+      each_with_index do |item, index| 
+        map[index] = self[index]
+      end
+      map
+    end    
+  end
+end

data/lib/fauxsql/attribute_map.rb

@@ -0,0 +1,32 @@
+module Fauxsql
+  # AttributeMap is an Hash that dereferences and resolves fauxsql attributes
+  # when setting/reading members in the Hash
+  class AttributeMap < Hash
+    include Attribute
+    
+    # We dereference and resolve the key because in Ruby _any_ object
+    # can be a hash key. Even a DataMapper record.
+    def []= key, value
+      real_key   = Fauxsql.dereference_fauxsql_attribute(key)
+      real_value = Fauxsql.dereference_fauxsql_attribute(value)
+      super real_key.hash, real_value
+    end
+
+    def [] key
+      real_key = Fauxsql.dereference_fauxsql_attribute(key)
+      Fauxsql.resolve_fauxsql_attribute super(real_key.hash)
+    end
+    
+    # VERY VERY SPECIFIC to the marshal dump format.
+    # Probably brittle.
+    def keys
+      super.map do |key|
+        if key.match(/^.+Fauxsql::DereferencedAttribute.+@klass.+@lookup_key.+$/)
+          Fauxsql::DereferencedAttribute.load(key)
+        else
+          key
+        end
+      end
+    end
+  end
+end

data/lib/fauxsql/dereferenced_attribute.rb

@@ -0,0 +1,25 @@
+module Fauxsql
+  # DereferencedAttribute stores objects that quack like DataMapper::Resource
+  # This is the object that Fauxsql stores in the database when a 
+  # DataMapper::Resource object is given. This way only the class and the 
+  # primary key are stored.
+  class DereferencedAttribute
+    def initialize(attribute)
+      @klass      = attribute.class
+      @lookup_key = attribute.key
+    end
+    
+    def resolve
+      @klass.get(*@lookup_key)
+    end
+    
+    def dump
+      Marshal.dump(self)
+    end
+    alias hash dump
+    
+    def self.load(dump)
+      Marshal.load(dump)
+    end
+  end
+end

data/lib/fauxsql/dsl.rb

@@ -0,0 +1,53 @@
+module Fauxsql
+  module DSL
+    # DSL method to define a named Fauxsql attribute
+    #
+    # calling with 'power' is like writing:
+    #   def power
+    #     get_fauxsql_attribute(:power)
+    #   end
+    #
+    #   def power=(value)
+    #     set_fauxsql_attribute(:power, value)
+    #   end
+    def attribute(attribute_name)
+      class_eval <<EORUBY
+        def #{attribute_name}
+          get_fauxsql_attribute(:#{attribute_name})
+        end
+
+        def #{attribute_name}=(value)
+          set_fauxsql_attribute(:#{attribute_name}, value)
+        end
+EORUBY
+    end
+
+    # DSL method to define a named Fauxsql list
+    #
+    # calling with 'squad_members' is like writing:
+    #   def squad_members
+    #     get_fauxsql_list(:squad_members)
+    #   end
+    def list(attribute_name)
+      class_eval <<EORUBY
+        def #{attribute_name}
+          get_fauxsql_list(:#{attribute_name})
+        end
+EORUBY
+    end
+
+    # DSL method to define a named Fauxsql map
+    #
+    # calling with 'mitigates' is like writing:
+    #   def mitigates
+    #     get_fauxsql_map(:mitigates)
+    #   end
+    def map(attribute_name)
+      class_eval <<EORUBY
+        def #{attribute_name}
+          get_fauxsql_map(:#{attribute_name})
+        end
+EORUBY
+    end
+  end
+end

data/lib/fauxsql.rb

@@ -0,0 +1,70 @@
+# Libs
+require 'active_support/concern'
+require 'datamapper'
+require 'pathname'
+
+# Internal Libs
+root = Pathname.new(__FILE__).dirname.expand_path
+require root+'fauxsql/dereferenced_attribute'
+require root+'fauxsql/attribute'
+require root+'fauxsql/attribute_list'
+require root+'fauxsql/attribute_map'
+require root+'fauxsql/dsl'
+module Fauxsql
+  extend ActiveSupport::Concern
+  
+  included do
+    property :fauxsql_attributes, Object, :default => {}
+    extend Fauxsql::DSL
+  end
+  
+  # Getter method for attributes defined as:
+  #   attribute :attribute_name
+  def get_fauxsql_attribute(attribute_name)
+    attribute = fauxsql_attributes[attribute_name]
+    Fauxsql.resolve_fauxsql_attribute(attribute)
+  end
+
+  # Setter method for attributes defined as:
+  #   attribute :attribute_name
+  def set_fauxsql_attribute(attribute_name, value)
+    attribute = Fauxsql.dereference_fauxsql_attribute(value)
+    fauxsql_attributes[attribute_name] = attribute
+  end
+  
+  # Gets a reference to an AttributeList object. AttributeList quacks like
+  # a Ruby Array. Except it uses Fauxsql's dereference and resolve strategy to
+  # store members.
+  def get_fauxsql_list(list_name)
+    fauxsql_attributes[list_name] or AttributeList.new(self, list_name)
+  end
+
+  # Gets a reference to an AttributeMap object. AttributeMap quacks like
+  # a Ruby Hash. Except it uses Fauxsql's dereference and resolve strategy to
+  # store keys and values.  
+  def get_fauxsql_map(map_name)
+    fauxsql_attributes[map_name] or AttributeMap.new(self, map_name)
+  end
+
+  # When setting values, all attributes pass through this method.
+  # This way we can control how certain classes are serialized by Fauxsql
+  # See #resolve_fauxsql_attribute to see how attributes are read.
+  def self.dereference_fauxsql_attribute(attribute)
+    if attribute.is_a?(DataMapper::Resource)
+      DereferencedAttribute.new(attribute)
+    else
+      attribute
+    end
+  end
+  
+  # When reading values, all attributes pass through this method.
+  # This way we can control how certain classes are deserialized by Fauxsql
+  # See #dereference_fauxsql_attribute to see how attributes are stored.
+  def self.resolve_fauxsql_attribute(attribute)
+    if attribute.is_a?(DereferencedAttribute)
+      attribute.resolve
+    else
+      attribute
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+require 'datamapper'
+DataMapper.setup(:default, "sqlite3://:memory:")
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fauxsql'
+
+class Test::Unit::TestCase
+  def reload
+    @faux.save
+    @faux.reload
+  end
+end

data/test/test_fauxsql.rb

@@ -0,0 +1,127 @@
+require 'test/helper'
+
+class SimpleKey
+  include DataMapper::Resource  
+  property :id, Serial
+end
+
+class ComplexKey
+  include DataMapper::Resource
+  property :string, String, :key => true
+  property :integer, Integer, :key => true
+end
+
+class FauxObject
+  include DataMapper::Resource
+  include Fauxsql
+  
+  property :id, Serial
+  property :type, Discriminator
+  attribute :name
+  attribute :record
+  list :things
+  map :dictionary
+end
+
+class OtherFauxObject < FauxObject; end
+
+class TestFauxsql < Test::Unit::TestCase
+  context "A FauxObject" do
+    setup do
+      DataMapper.auto_migrate!
+      @faux = FauxObject.new
+    end
+    
+    should "have getters and setters for attributes" do
+      assert @faux.respond_to?(:name)
+      assert @faux.respond_to?(:name=)
+    end
+    
+    should "have getter for lists" do
+      assert @faux.respond_to?(:things)
+    end
+    
+    should "have getters and setters for maps" do
+      assert @faux.respond_to?(:dictionary)
+    end
+    
+    should "persist attributes" do
+      @faux.name = "MyName"
+      reload
+      assert_equal "MyName", @faux.name
+    end
+    
+    should "persist lists" do
+      @faux.things << :hello
+      @faux.things << :goodbye
+      reload
+      assert_equal [:hello, :goodbye], @faux.things
+    end
+    
+    should "persist maps" do
+      @faux.dictionary[:a] = 1
+      @faux.dictionary[:b] = 2
+      reload
+      assert_equal 1, @faux.dictionary[:a]
+      assert_equal 2, @faux.dictionary[:b]
+    end
+    
+    should "dereference and resolve objects that include Fauxsql" do
+      has_fauxsql = OtherFauxObject.create
+      @faux.record = has_fauxsql
+      reload
+      assert_equal has_fauxsql, @faux.record
+    end
+    
+    should "dereference and resolve dm objects with simple keys" do
+      simple_key = SimpleKey.create
+      @faux.record = simple_key
+      reload
+      assert @faux.fauxsql_attributes[:record].is_a?(Fauxsql::DereferencedAttribute)
+      assert_equal simple_key, @faux.record
+    end
+    
+    should "deference and resolve dm objects with complex keys" do
+      complex_key = ComplexKey.create(:string => "string", :integer => 1)
+      @faux.record = complex_key
+      reload
+      assert @faux.fauxsql_attributes[:record].is_a?(Fauxsql::DereferencedAttribute)
+      assert_equal complex_key, @faux.record
+    end
+    
+    should "derefencenc and resolve dm objects in lists" do
+      simple = SimpleKey.create
+      @faux.things << :hello
+      @faux.things << simple
+      @faux.things << :goodbye
+      reload
+      assert_equal [:hello, simple, :goodbye], @faux.things.map_resolved
+    end
+    
+    should "derefencenc and resolve fauxsql objects in lists" do
+      has_fauxsql = OtherFauxObject.create
+      @faux.things << :hello
+      @faux.things << has_fauxsql
+      @faux.things << :goodbye
+      reload
+      assert_equal [:hello, has_fauxsql, :goodbye], @faux.things.map_resolved
+    end
+
+    should "derference and resolve dm objects with fauxsql in maps" do
+      has_fauxsql1 = OtherFauxObject.create
+      has_fauxsql2 = OtherFauxObject.create
+      @faux.dictionary[has_fauxsql1] = has_fauxsql2
+      reload
+      assert_equal has_fauxsql2, @faux.dictionary[has_fauxsql1]
+    end
+
+    should "derference and resolve dm objects in maps" do
+      simple1 = SimpleKey.create
+      simple2 = SimpleKey.create
+      @faux.dictionary[simple1] = simple2
+      assert_equal Fauxsql::DereferencedAttribute, @faux.dictionary.keys.first.class
+      reload
+      assert_equal simple2, @faux.dictionary[simple1]
+    end
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: fauxsql
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Collin Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-20 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: datamapper
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: do_sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - pre
+        version: 3.0.pre
+  type: :runtime
+  version_requirements: *id004
+description: And description
+email: collintmiller@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- fauxsql.gemspec
+- lib/fauxsql.rb
+- lib/fauxsql/attribute.rb
+- lib/fauxsql/attribute_list.rb
+- lib/fauxsql/attribute_map.rb
+- lib/fauxsql/dereferenced_attribute.rb
+- lib/fauxsql/dsl.rb
+- test/helper.rb
+- test/test_fauxsql.rb
+has_rdoc: true
+homepage: http://github.com/collin/fauxsql
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: This is summary
+test_files: 
+- test/helper.rb
+- test/test_fauxsql.rb