tracks-attributes 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,60 @@
+
+[![Build Status](https://travis-ci.org/leopoldodonnell/tracks-attributes.png?branch=master)](https://travis-ci.org/leopoldodonnell/tracks-attributes)
+[![Dependency Status](https://gemnasium.com/leopoldodonnell/tracks-attributes.png)](https://gemnasium.com/leopoldodonnell/tracks-attributes)
+[![Code Climate](https://codeclimate.com/github/leopoldodonnell/tracks-attributes.png)](https://codeclimate.com/github/leopoldodonnell/tracks-attributes)
+# TracksAttributes
+
+TracksAttributes adds the ability to track ActiveRecord and Object level attributes.
+
+Sometimes you just need to know what your accessors are at runtime, like when you're writing a controller that
+needs to return JSON or XML. This module extends ActiveRecord::Base with the *tracks_attributes* class method. Once this has 
+been called the class is extended with the ability to track attributes through *attr_accessor*, *attr_reader*, and *attr_writer*.
+Plain old Ruby classes may also use *TracksAttributes* by including it as a module first.
+
+## Enhanced JSON and XML processing
+
+Beyond the ability to track your attributes, this gem simplifies your use of converting your objects to an from JSON or XML.
+Once a class has been extended, it can convert to and from JSON or XML without having to explicitly include attributes.
+
+Example:
+```ruby
+class Person < ActiveRecordBase
+  tracks_attributes
+  
+  attr_accessible :name, :email
+  attr_accessor :favorite_food
+end
+
+fred = Person.find_by_name("Fred")
+fred.favorite_food = 'Brontosaurus Burgers'
+
+fred_json = fred.to_json
+puts fred_json
+# => {"id":1,"name":"Fred","email":"fred@bedrock.com","favorite_food":"Brontosaurus Burgers"}
+
+fred2 = Person.new
+fred2.from_json(fred_json)
+puts "#{fred2.name} loves #{fred2.favorite_food}"
+# => Fred loves Brontosaurus Burgers
+```
+Both the JSON and XML take the same options as their Hash and ActiveRecord counterparts so you can still
+use *:only* and *:includes* in your code as needed.
+
+## Add Validations To Non Active Record Attributes
+
+To add ActiveModel::Validations to your class just initialize your class with *tracks_attributes* as
+
+```ruby
+  tracks_attributes :validates => true
+```  
+## Installation
+
+Add the following to your Gemfile
+
+    gem 'tracks-attributes', :git => "git://github.com/leopoldodonnell/tracks-attributes"
+
+Then call bundle to install it.
+
+    > bundle
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+require 'rspec/core/rake_task'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TracksAttributes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/tasks/tracks_attributes_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :tracks_attributes do
+#   # Task goes here
+# end

data/lib/tracks_attributes/railtie.rb

@@ -0,0 +1,10 @@
+require 'active_record/railtie'
+require 'active_support/core_ext'
+
+module TracksAttributes
+  class Railtie < Rails::Railtie
+    if defined?(ActiveRecord::Base)
+      ActiveRecord::Base.send :include, TracksAttributes
+    end
+  end
+end

data/lib/tracks_attributes/version.rb

@@ -0,0 +1,3 @@
+module TracksAttributes
+  VERSION = "1.0.0"
+end

data/lib/tracks_attributes.rb

@@ -0,0 +1,127 @@
+# @author Leo O'Donnell
+
+##
+# A Module that can be used to extend ActiveRecord or Plain Old Ruby Objects
+# with the ability to track all attributes. It also simplifies streaming to and
+# from JSON or XML since it will automatically consider all attributes in the
+# conversion.
+#
+# This module can also be used as building block for other classes that need to
+# be dynamically aware of their attributes.
+#
+module TracksAttributes
+  extend ActiveSupport::Concern
+  
+  module ClassMethods
+    ##
+    # Call this class method to begin tracking attributes on a class.
+    #
+    # @param [Hash] options With values:
+    #   * :validates => true will enable attribute validation
+    #
+    # Note:
+    #   Classes that include TracksAttributes will not be extended unless
+    #   until this method is called.
+    #
+    # @see TracksAttributesInternal TracksAttributesInternal for full method list
+    def tracks_attributes(options={})
+      include TracksAttributesInternal
+      include ActiveModel::Validations if options[:validates]
+      self
+    end
+  end
+  
+  module TracksAttributesInternal
+    extend ActiveSupport::Concern
+
+    included do
+      @tracked_attrs ||= []
+    end
+
+    module ClassMethods
+      # override attr_accessor to track accessors for an TracksAttributes
+      def attr_accessor(*vars)
+        @tracked_attrs.concat vars
+        super
+      end
+
+      # override attr_reader to track accessors for an TracksAttributes
+      def attr_reader(*vars)
+        @tracked_attrs.concat vars
+        super
+      end
+
+      # override attr_writer to track accessors for an TracksAttributes
+      def attr_writer(*vars)
+        # avoid tracking attributes that are added by the class_attribute
+        # as these are class attributes and not instance attributes.
+        @tracked_attrs.concat vars.reject {|var| respond_to? var }
+        super
+      end
+
+      # return an array of all of the attributes that are not in active record
+      def accessors
+        @tracked_attrs ||= []
+      end
+
+    end
+
+    # Return the array of accessor symbols for instances of this
+    # class.
+    def accessors
+      self.class.accessors
+    end    
+
+    # Return a hash all of the accessor symbols and their values
+    def all_attributes
+      attributes.merge Hash[accessors.collect {|v| [v, send(v.to_s)] if respond_to? "#{v}".to_sym}]
+    end
+
+    # Set all attributes with hash of symbols and their values and returns instance
+    def all_attributes=(hash = {})
+      hash.each {|k, v| send("#{k.to_s}=", v) if respond_to? "#{k.to_s}=".to_sym}
+      self
+    end
+
+    # Convert an TracksAttributes instance to JSON by delegating conversion to Hash.to_json
+    #
+    # @param [Hash] options
+    #   * Without any options, the returned JSON string will include all of the attributes.
+    #   * :only => one, or an array of Hash Keys that define which keys to process
+    #   * :except => one, or an array of Hash Keys that define which keys not to process
+    #
+    def to_json(options = nil)
+      all_attributes.to_json(options)
+    end
+
+    # Returns an instance of TracksAttributes from a JSON string
+    def from_json(json, include_root=false)
+      hash = ActiveSupport::JSON.decode(json)
+      hash = hash.values.first if include_root
+      self.all_attributes = hash
+    end
+
+    # Convert an TracksAttributes instance to XML by delegating conversion to Hash.to_xml
+    #
+    # @param [Hash] options
+    #   * Without any options, the returned XML string will include all of the attributes.
+    #   * :only => one, or an array of Hash Keys that define which keys to process
+    #   * :except => one, or an array of Hash Keys that define which keys not to process
+    #
+    # The :builder option uses key as the :root for the XML
+    # result
+    #
+    def to_xml(options = nil)
+      all_attributes.to_xml(options || {})
+    end
+
+    # Returns an instance of TracksAttributes from an XML string
+    def from_xml(xml)
+      hash = Hash.from_xml(xml).values.first
+      self.all_attributes = hash
+    end
+
+  end
+end
+
+require 'tracks_attributes/railtie'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: tracks-attributes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Leo O'Donnell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !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'
+description: ! "Sometimes you just need to know what your accessors are at runtime,
+  like when you're writing a controller that\n  needs to return JSON or XML..."
+email:
+- leopold.odonnell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tasks/tracks_attributes_tasks.rake
+- lib/tracks_attributes/railtie.rb
+- lib/tracks_attributes/version.rb
+- lib/tracks_attributes.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/leopoldodonnell/tracks-attributes
+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: TracksAttributes adds the ability to track ActiveRecord and Object level
+  attributes.
+test_files: []
+has_rdoc: