inactive_record 1.0.3

data/History.txt

@@ -0,0 +1,13 @@
+== 1.0.3 2010-01-04
+
+* Added a :methods option to #to_xml that acts just as its ActiveRecord counterpart does.
+* Refactored #to_xml to be more concise.
+
+== 1.0.2 2009-06-24
+
+* Add attr_human_name method.
+
+
+== 1.0.0 2009-04-03
+
+* Initial release

data/README.rdoc

@@ -0,0 +1,82 @@
+= inactive_record
+
+http://github.com/midas/inactive_record/tree/master
+
+
+== DESCRIPTION:
+
+InactiveRecord gives you many of the features you know and love from ActiveRecord without the need for a backing
+database table.
+
+
+== FEATURES:
+
+* An initialize method that accepts an attribute hash, including the Rails Date/Time select methods (ie. start_date(1i), etc...)
+* A to_xml method that accepts the same options as its respective ActiveRecord method
+* All validations work when you call valid?, excluding validates_uniqueness_of
+* Supports errors_for method (when validations fail, just render the new or edit form as you mormaly would)
+* Works with Rails 2.3
+
+
+==PROBLEMS:
+
+
+== INSTALL:
+
+  sudo gem install midas-inactive_record
+
+
+== USE:
+
+Add gem requirement to your environment.rb file:
+
+  config.gem 'midas-inactive_record', :version => '1.0.0', :lib => 'inactive_record', :source => 'http://gems.github.com'
+
+Create a model class:
+
+  class Thing < InactiveRecord::Base
+    attr_accessor :name, :begin_date, :end_date
+    validates_presence_of :name, :begin_date, :end_date
+  end
+
+In things_controller.rb:
+
+  @thing = Thing.new( params[:thing] )
+  
+  unless @thing.valid?
+    render :new
+    return
+  end
+
+Now you can use errors_for, etc in your forms.
+
+
+== REQUIREMENTS:
+
+* ActiveRecord >= 2.2.0
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 C. Jason Harrelson (midas)
+
+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/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "inactive_record"
+    gem.summary = %Q{InactiveRecord gives you many of the features you know and love from ActiveRecord without the need for a backing database table.}
+    gem.description = %Q{InactiveRecord gives you many of the features you know and love from ActiveRecord without the need for a backing database table.}
+    gem.email = "jason@lookforwardenterprises.com"
+    gem.homepage = "http://github.com/midas/inactive_record"
+    gem.authors = ["C. Jason Harrelson (midas)"]
+    gem.add_dependency "activerecord", ">= 2.2"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # 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 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "inactive_record #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.3

data/inactive_record.gemspec

@@ -0,0 +1,62 @@
+# 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{inactive_record}
+  s.version = "1.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["C. Jason Harrelson (midas)"]
+  s.date = %q{2010-01-04}
+  s.description = %q{InactiveRecord gives you many of the features you know and love from ActiveRecord without the need for a backing database table.}
+  s.email = %q{jason@lookforwardenterprises.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "History.txt",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "inactive_record.gemspec",
+     "lib/inactive_record.rb",
+     "lib/inactive_record/base.rb",
+     "script/console",
+     "script/destroy",
+     "script/generate",
+     "spec/inactive_record/base_spec.rb",
+     "spec/inactive_record_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tasks/rspec.rake"
+  ]
+  s.homepage = %q{http://github.com/midas/inactive_record}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{InactiveRecord gives you many of the features you know and love from ActiveRecord without the need for a backing database table.}
+  s.test_files = [
+    "spec/inactive_record/base_spec.rb",
+     "spec/inactive_record_spec.rb",
+     "spec/spec_helper.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_runtime_dependency(%q<activerecord>, [">= 2.2"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 2.2"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 2.2"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/inactive_record/base.rb

@@ -0,0 +1,191 @@
+require 'active_record'
+require 'active_record/base'
+
+module InactiveRecord
+  class Base
+      
+    def initialize( attributes={} )
+      unless attributes.nil?
+        # Fix any dates/times from rails date_select
+        keys = attributes.keys
+        date_keys = keys.grep(/(1i)/)
+        time_keys = keys.grep(/(4i)/)
+        date_keys.each do |date_key|
+          key = date_key.to_s.gsub( /\(1i\)/, '' )
+          num = keys.grep( /#{key.to_s}/ ).size
+          if num == 3
+            # Date
+            attributes[key.to_sym] = Date.civil( attributes.delete( "#{key}(1i)".to_sym ).to_i,
+              attributes.delete( "#{key}(2i)".to_sym ).to_i, attributes.delete( "#{key}(3i)".to_sym ).to_i )
+          elsif num == 5
+            #DateTime
+            attributes[key.to_sym] = DateTime.civil( attributes.delete( "#{key}(1i)".to_sym ).to_i,
+              attributes.delete( "#{key}(2i)".to_sym ).to_i, attributes.delete( "#{key}(3i)".to_sym ).to_i,
+              attributes.delete( "#{key}(4i)".to_sym ).to_i, attributes.delete( "#{key}(5i)".to_sym ).to_i )
+          elsif num == 6
+            #DateTime
+            attributes[key.to_sym] = DateTime.civil( attributes.delete( "#{key}(1i)".to_sym ).to_i,
+              attributes.delete( "#{key}(2i)".to_sym ).to_i, attributes.delete( "#{key}(3i)".to_sym ).to_i,
+              attributes.delete( "#{key}(4i)".to_sym ).to_i, attributes.delete( "#{key}(5i)".to_sym ).to_i,
+              attributes.delete( "#{key}(6i)".to_sym ).to_i )
+          end
+        end
+
+        attributes.each do |key, value|
+          self.instance_variable_set("@#{key}", value)
+        end
+      end
+      yield self if block_given?
+    end
+
+    def []( key )
+      instance_variable_get("@#{key}")
+    end
+
+    def method_missing( method_id, *args )
+      if md = /_before_type_cast$/.match(method_id.to_s)
+        attr_name = md.pre_match
+        return self[attr_name] if self.respond_to?(attr_name)
+      end
+      super
+    end
+
+    # Instructions on how to build xml for an object.
+    #
+    # *options*
+    # :only - A symbol or array of symbols of instance variable names to include in the xml.
+    # :except - A symbol or array of symbols of instance variable names to exclude in the xml.
+    # :methods - A symbol or array of symbols of methods to evaluate and include in the xml.
+    # :skip_instruct - If true, output the document type, otherwise do not.
+    # :skip_types - (not yet) If true, do not output types of variables that are not strings.
+    # :include - (not yet) First level associations to include.
+    # :dasherize - If true, convert underscored variable names to dasherized variable names.
+    #
+    def to_xml( options={} )
+      options[:indent] ||= 2
+      except = options[:except]
+      methods = options[:methods]
+      only = options[:only]
+      throw 'Both the :except and :only options cannot be used simultaneously.' if !except.nil? && !only.nil?
+
+      only = only.map { |attribute| attribute.to_sym } if only.is_a?( Array )
+      only = Array.new << only.to_sym if only.is_a?( String )
+      only = Array.new << only if only.is_a?( Symbol )
+      except = except.map { |attribute| attribute.to_sym } if except.is_a?( Array )
+      except = Array.new << except.to_sym if except.is_a?( String )
+      except = Array.new << except if except.is_a?( Symbol )
+      methods = methods.map { |attribute| attribute.to_sym } if methods.is_a?( Array )
+      methods = Array.new << methods.to_sym if methods.is_a?( String )
+      methods = Array.new << methods if methods.is_a?( Symbol )
+      dasherize = options[:dasherize]
+      dasherize = true unless !dasherize.nil?
+      
+      attrs = self.instance_variables.map { |var| var.to_s.gsub( /@/, '' ).to_sym }
+      to_serialize = []
+      to_serialize += methods unless methods.nil?
+      if only
+        to_serialize += (attrs.select { |var| only.include?( var ) })
+      elsif except
+        to_serialize += (attrs - except)
+      else
+        to_serialize += attrs unless attrs.nil?
+      end
+
+      xml = options[:builder] ||= Builder::XmlMarkup.new( :indent => options[:indent] )
+      xml.instruct! unless options[:skip_instruct]
+      el_tag_name = dasherize ? self.class.to_s.underscore.dasherize : self.class.to_s.underscore
+      xml.tag!( el_tag_name ) do
+        to_serialize.each do |attribute|
+          var_name = dasherize ? attribute.to_s.dasherize : attribute
+          attr_val = self.send( attribute ) if self.respond_to?( attribute )
+          if attr_val.is_a?( Array )
+            xml << attr_val.to_xml( :skip_instruct => true )
+          else
+            if attr_val.nil?
+              is_nil = 'true'
+            elsif attr_val.is_a?( TrueClass ) || attr_val.is_a?( FalseClass )
+              type = 'boolean' 
+            elsif attr_val.is_a?( Integer ) || attr_val.is_a?( Fixnum )
+              type = 'integer'
+            elsif attr_val.is_a?( Float )
+              type = 'float'
+            elsif attr_val.is_a?( DateTime ) || attr_val.is_a?( Date ) || attr_val.is_a?( Time )
+              type = 'datetime'
+            end
+            
+            if is_nil
+              xml.tag!( var_name, attr_val, :nil => is_nil ) #unless attr_val.nil?
+            elsif type
+              xml.tag!( var_name, attr_val, :type => type ) #unless attr_val.nil?
+            else
+              xml.tag!( var_name, attr_val ) #unless attr_val.nil?
+            end
+          end
+        end
+      end
+    end
+
+    def new_record?
+      true
+    end
+
+    def self.self_and_descendents_from_active_record
+      [self]
+    end
+
+    def self.self_and_descendants_from_active_record
+      [self]
+    end
+
+    def self.human_name( options={} )
+      Base.human_attribute_name(@name)
+    end
+    
+    # Allows alternate humanized versions of attributes to be set.  For example, an attribute such as 'num_employees' would be
+    # converted to 'Num employees' normally using <tt>human_attribute_name</tt>.  More descriptive text can be set. Example:
+    #   attr_human_name 'num_employees' => 'Number of employees'
+    def self.attr_human_name(attributes) # :nodoc:
+      attributes.stringify_keys!
+      write_inheritable_hash("attr_human_name", attributes || {})
+
+      # assign the current class to each column that is being assigned a new human attribute name
+      #self.columns.reject{|c| !attributes.has_key?(c.name)}.each{|c| c.parent_record_class = self}
+    end
+    
+    def self.human_name_attributes # :nodoc:
+      read_inheritable_attribute("attr_human_name")
+    end
+
+    # Transforms attribute key names into a more humane format, such as "First name" instead of "first_name". Example:
+    #   Person.human_attribute_name("first_name") # => "First name"
+    def self.human_attribute_name(attribute_key_name) #:nodoc:
+      (read_inheritable_attribute("attr_human_name") || {})[attribute_key_name.to_s] || ""
+    end
+
+    protected
+
+    def raise_not_implemented_error(*params)
+      ValidatingModel.raise_not_implemented_error(*params)
+    end
+
+    alias save raise_not_implemented_error
+    alias update_attribute raise_not_implemented_error
+    alias save! raise_not_implemented_error
+
+    public
+    include ActiveRecord::Validations
+
+    class << self
+      def raise_not_implemented_error(*params)
+        raise NotImplementedError
+      end
+
+      alias validates_uniqueness_of raise_not_implemented_error
+      alias create! raise_not_implemented_error
+      alias validate_on_create raise_not_implemented_error
+      alias validate_on_update raise_not_implemented_error
+      alias save_with_validation raise_not_implemented_error
+    end
+
+  end
+end

data/lib/inactive_record.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'inactive_record/base'
+
+module InactiveRecord
+  VERSION = '1.0.3'
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/inactive_record.rb'}"
+puts "Loading inactive_record gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/inactive_record_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Place your specs here" do
+  
+  it "find this spec in spec directory" do
+    violated "Be sure to write your specs"
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'inactive_record'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: inactive_record
+version: !ruby/object:Gem::Version 
+  version: 1.0.3
+platform: ruby
+authors: 
+- C. Jason Harrelson (midas)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-04 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.2"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: InactiveRecord gives you many of the features you know and love from ActiveRecord without the need for a backing database table.
+email: jason@lookforwardenterprises.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- History.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- inactive_record.gemspec
+- lib/inactive_record.rb
+- lib/inactive_record/base.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/inactive_record/base_spec.rb
+- spec/inactive_record_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/midas/inactive_record
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: InactiveRecord gives you many of the features you know and love from ActiveRecord without the need for a backing database table.
+test_files: 
+- spec/inactive_record/base_spec.rb
+- spec/inactive_record_spec.rb
+- spec/spec_helper.rb