dynattribs 0.0.1

data/.gitignore

@@ -0,0 +1,15 @@
+.DS_Store
+log/*
+tmp/**/*
+bin/*
+*.log
+*~
+.project
+.loadpath
+._*
+.bundle
+*.gem
+*.swp
+Gemfile.lock
+.rvmrc
+.redcar/*

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 James P. McGrath
+
+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,81 @@
+= Dynattribs (Dynamic Attributes)
+Dynattribs makes it easy to declare dynamic attributes in ActiveRecord classes.
+
+== Overview
+
+The Dynattribs Gem (Dyanmic Attributes) provide a database backed attributes to 
+ActiveRecord::Base classes, without having to declare table columns for each 
+attribute. A bit of NoSQL data flexibility for traditional database backed 
+ActiveRecord classes.
+
+The dynamic attributes are stored as a JSON encoded Hash, and can be 
+persisted into any field that can store text data.
+
+== Installation
+
+You can use the Dynattribs in your Rails project by including the following in your Gemfile:
+
+  gem 'dynattribs'
+  
+== Usage
+ 
+To use Dynattribs you need to include the mixin in your class definition, preferably at the top.
+
+To define the names of the dynamic attributes use the "dynamic_attr_accessor"
+method. This method takes two of more arguments. The first argument is the name
+of the database field that the dynamic attributes will be persisted to. The other
+arguments are the names of the dynamic attributes. It is meant to be used in a
+similar way to the familure "attr_accessor" method
+
+
+=== Example
+The following example defines a dynamic "info" field for the MyClass class, with 
+the new info field's data being persisted to the "extra_data" database field.
+ 
+  class MyClass < < ActiveRecord::Base
+    include Dynattribs
+     
+    dynamic_attr_accessor :extra_data, :info
+  end
+
+=== Database
+The dynamic attributes are stored converted to a JSON encoded string before storing
+to the nominated database field. Therefore, you will need to add a string column
+to the table of any class you wish to add dynamic attributes too.
+
+A String field would work, but a "text" field would be best due to the large amount 
+of data that could be stored in the dynamic attributes.
+
+To add the new column, create a migration, e.g.
+
+  rails g migration add_model_dynamic_attribute
+
+And modify the migration to look something like this:
+
+  class AddModelDynamicAttribute < ActiveRecord::Migration
+    def change
+      add_column :models, :dynamic_attribs, :text
+    end
+  end  
+
+== In The Wild
+
+Dynattribs is used in a number of production systems:
+
+{Capstory - Private Group Photo Albums }[http://www.capstory.com/]
+
+{Authic - A Local shopping Sales Notification Service}[http://www.authic.com]
+
+If you are using Dynattribs in your project and would like to be added to this list, please get in touch!
+
+== Contributing
+
+Contributions are very welcome. Please ensure all pull requests include suitable test coverage and all tests are passing.
+
+== Authors
+
+* {James McGrath}[https://github.com/jpmcgrath]
+
+== Licence
+
+This code is licensed under the MIT license. See MIT-LICENCE for more details.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+RSpec::Core::RakeTask.new
+
+RDoc::Task.new :rdoc do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Dynattribs'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/dynattribs.gemspec

@@ -0,0 +1,23 @@
+require File.expand_path("../lib/dynattribs/version", __FILE__)
+
+# Provide a simple gemspec so you can easily use your enginex
+# project in your rails apps through git.
+Gem::Specification.new do |s|
+  s.name                      = "dynattribs"
+  s.summary                   = "Dynattribs makes it easy to declare dynamic attributes in ActiveRecord classes."
+  s.description               = "The Dynattribs Gem (Dyanmic Attributes) provide a database backed attributes to ActiveRecord::Base classes, without having to declare table columns for each attribute. A bit of NoSQL data flexibility for traditional database backed ActiveRecord classes."
+  s.files                     = `git ls-files`.split("\n")
+  s.version                   = Dynattribs::VERSION
+  s.platform                  = Gem::Platform::RUBY
+  s.authors                   = [ "James P. McGrath" ]
+  s.email                     = [ "gems@jamespmcgrath.com" ]
+  s.homepage                  = "http://jamespmcgrath.com/projects/dynattribs"
+  s.rubyforge_project         = "dynattribs"
+  s.required_rubygems_version = "> 1.3.6"
+  #s.add_dependency "rails", ">= 3.0.7"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "activerecord"
+  s.executables = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/lib/dynattribs.rb

@@ -0,0 +1,83 @@
+module Dynattribs
+
+  ############################################################
+  #
+  # PARSE AND ENCODE THE DYNAMIC FIELD DATA
+  # the data is stored to a field defined by "dynamic_attributes_backing_field_name"
+  #
+  ############################################################
+
+  # parse and return the json encoded values from the encoded
+  # data stored in the nominated attribute
+  def mapped_data
+    return {} if self[dynamic_attributes_backing_field_name].nil?
+    JSON.parse(self[dynamic_attributes_backing_field_name])
+  end
+
+  # JSON encode and store a hash of attributes
+  def mapped_data=hash
+    self[dynamic_attributes_backing_field_name] = hash.to_json
+  end
+
+  ############################################################
+  #
+  # GENERAL GET/SET METHODS
+  #
+  ############################################################
+
+  # a general method for retieving a named attribute
+  # from the encoded data
+  def get_dynamic_attr(attr_name)
+    mapped_data[attr_name]
+  end
+
+  # a general method to set the value of the named 
+  # attribute in the data map
+  def set_dynamic_attr(attr_name, value)
+    data_map = self.mapped_data
+    data_map[attr_name] = value
+    self.mapped_data = data_map
+  end
+
+  ############################################################
+  #
+  # CLASS METHODS
+  #
+  ############################################################
+
+  # this bit of ma allows us to "include" class methods (instead of
+  # the normal "extend")with the mixin.
+  # which is needed as the dynamic_attr_accessor method needs
+  # to be invoked as a class method as it is used in the class
+  # definition, rather than from within a instance method
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+
+    # takes two or more arguments, first arg is the name of the database
+    # field that backs the dynamic fields data hash.
+    # the other arguments are used to create getter/setter methods of 
+    # the arguments name.
+    def dynamic_attr_accessor(*args)
+   
+      # the first element in the array is the name of the field
+      # used to store the json encoded dynamic attribute data
+      dynamic_attributes_backing_field_name = args.shift
+      # create a method to access this extra data field name
+      self.class_eval("def dynamic_attributes_backing_field_name;'#{dynamic_attributes_backing_field_name}';end") if !dynamic_attributes_backing_field_name.empty?
+
+      # iterate through the rest of the arguments and create
+      # a getter and setter method of each of the desired dynamic attributes
+      args.each do |arg|
+        # getter - creates a wrapper for the get_dynamic_attr method
+        self.class_eval("def #{arg};get_dynamic_attr('#{arg}');end")
+
+        # setter - creates a wrapper for the set_dynamic_attr method
+        self.class_eval("def #{arg}=(val);set_dynamic_attr('#{arg}', val); end")
+      end
+    end
+  end
+
+end

data/lib/dynattribs/version.rb

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

data/spec/dummy/db/migrate/00001_create_my_test_class.rb

@@ -0,0 +1,9 @@
+class CreateMyTestClass < ActiveRecord::Migration
+  def change
+    create_table(:my_test_classes) do |t|
+      ## Database authenticatable
+      t.string :email
+      t.text :dynamic_attribs
+    end
+  end
+end 

data/spec/dummy/my_test_class.rb

@@ -0,0 +1,8 @@
+require 'support/active_record'
+
+class MyTestClass < ActiveRecord::Base
+  include Dynattribs
+
+  dynamic_attr_accessor :dynamic_attribs, :info, :is_bool, :age, :tested_at
+
+end

data/spec/dynattribs_spec.rb

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe Dynattribs do
+
+  it "should store and load dynamic attributes" do
+    my_test_class = MyTestClass.new
+
+    my_test_class.info = "This will be stored into info"
+    my_test_class.is_bool = false
+    my_test_class.age = 24
+    my_test_class.tested_at = Time.now
+
+    my_test_class.save.should == true
+
+    loaded_object = MyTestClass.find(my_test_class.id)
+
+    loaded_object.nil?.should == false
+
+    loaded_object.info.should == my_test_class.info
+    loaded_object.is_bool.should == my_test_class.is_bool
+    loaded_object.age.should == my_test_class.age
+    loaded_object.tested_at.should == my_test_class.tested_at
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
+
+require 'dynattribs'
+require File.expand_path("../dummy/my_test_class.rb",  __FILE__)
+
+# Run any available migration
+ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)

data/spec/support/active_record.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_record'
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"

data/travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx-18mode
+  - rbx-19mode
+#  - jruby-18mode # JRuby in 1.8 mode # jruby does not build native extensions like the sqlite gem
+#  - jruby-19mode # JRuby in 1.9 mode

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: dynattribs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- James P. McGrath
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-13 00:00:00.000000000 Z
+dependencies:
+- !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: sqlite3
+  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: activerecord
+  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'
+description: The Dynattribs Gem (Dyanmic Attributes) provide a database backed attributes
+  to ActiveRecord::Base classes, without having to declare table columns for each
+  attribute. A bit of NoSQL data flexibility for traditional database backed ActiveRecord
+  classes.
+email:
+- gems@jamespmcgrath.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- dynattribs.gemspec
+- lib/dynattribs.rb
+- lib/dynattribs/version.rb
+- spec/dummy/db/migrate/00001_create_my_test_class.rb
+- spec/dummy/my_test_class.rb
+- spec/dynattribs_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+- travis.yml
+homepage: http://jamespmcgrath.com/projects/dynattribs
+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: 1.3.6
+requirements: []
+rubyforge_project: dynattribs
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Dynattribs makes it easy to declare dynamic attributes in ActiveRecord classes.
+test_files: []