active_finite 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,24 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+gem "activesupport", "~> 3.0.3"
+gem "activerecord", "~> 3.0.3"
+gem "json", "~> 1.5.1"
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end
+
+group :test do
+  gem "rspec", "~> 2.3.0"
+  gem 'sqlite3-ruby', '1.3.3', :require => 'sqlite3'
+  gem "activesupport", "~> 3.0.3"
+  gem "activerecord", "~> 3.0.3"
+end
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 me
+
+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,88 @@
+= active_finite
+
+== What is active_finite?
+
+The goal of active_finite is to provide a simple way to define
+database enumerations with ActiveRecord. There are many[https://github.com/ikspres/enum_fu] existing[https://github.com/adzap/active_enum] projects[https://github.com/jeffp/enumerated_attribute] that bring some enum support to ActiveRecord. However, these projects tend to define the enums in code, instead of in the migration itself. 
+
+== Hello, active_finite!
+
+Let's start by defining a simple migration:
+
+  require 'active_finite'
+  require 'active_record'
+  require 'active_support/core_ext'
+
+  class Hellos < ActiveRecord::Migration
+    self.up
+      create_table :hellos do |t|
+        t.string default_column_name, :null => false
+      end
+      create_finite in_table: :hellos, values: ['oy', 'que tal', 'hi']
+    end
+
+    self.down
+      drop_finite in_table: :hellos, values: ['oy', 'que tal', 'hi']
+      drop_table :hellos
+    end
+  end
+
+Note that if it doesn't matter what the column's name is, the method 
+default_column_name can be used.
+
+Now that we some hellos in our Hello model, we can access them using:
+hellos = active_finite :hellos
+
+The variable hellos now holds a class derived from ActiveRecord named 
+Hello, so all of the normal ActiveRecord methods can be used.
+By using the method active_finite, there is no need to define the model classes
+explicitly.
+
+== Other options
+If the column name must be different than the default (i.e. when working with
+an existing database), the column_name option can be used. Also, a json
+file can be used instead of explicitly listing the possible values in 
+the migration. For example:
+
+  require 'active_finite'
+  require 'active_record'
+  require 'active_support/core_ext'
+  class HellosWithCustomColumn < ActiveRecord::Migration
+    self.up
+      create_table :hellos do |t|
+        t.string :custom, :null => false
+      end
+      create_finite in_table: :hellos,
+                    values: ['oy', 'que tal', 'hi']
+                    column_name: :custom
+                    from_file: 'hellos.json'
+    end
+
+    self.down
+      drop_finite in_table: :hellos, values: ['oy', 'que tal', 'hi']
+      drop_table :hellos
+    end
+  end
+
+If both values and from_file are defined, active_finite will pull entries from both.
+
+== Other ideas
+Combine active_finite with foreigner[https://github.com/matthuhiggins/foreigner] to put foreign key constraints on users of defined enums.
+
+== Contributing to active_finite
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Contact
+me@stuffivemade.com
+
+== Copyright
+
+Copyright (c) 2011 me. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+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 = "active_finite"
+  gem.homepage = "http://github.com/r4pdevteam/active_finite"
+  gem.license = "MIT"
+  gem.summary = %Q{one-line summary of your gem}
+  gem.description = %Q{longer description of your gem}
+  gem.email = "me@stuffihavemade.com"
+  gem.authors = ["me"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "active_finite #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/active_finite.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{active_finite}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["me"]
+  s.date = %q{2011-04-12}
+  s.description = %q{longer description of your gem}
+  s.email = %q{me@stuffihavemade.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "active_finite.gemspec",
+    "lib/active_finite.rb",
+    "spec/active_finite_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/villans.json"
+  ]
+  s.homepage = %q{http://github.com/r4pdevteam/active_finite}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.0}
+  s.summary = %q{one-line summary of your gem}
+  s.test_files = [
+    "spec/active_finite_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.3"])
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0.3"])
+      s.add_runtime_dependency(%q<json>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+    else
+      s.add_dependency(%q<activesupport>, ["~> 3.0.3"])
+      s.add_dependency(%q<activerecord>, ["~> 3.0.3"])
+      s.add_dependency(%q<json>, ["~> 1.5.1"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, ["~> 3.0.3"])
+    s.add_dependency(%q<activerecord>, ["~> 3.0.3"])
+    s.add_dependency(%q<json>, ["~> 1.5.1"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+  end
+end
+

data/lib/active_finite.rb

@@ -0,0 +1,61 @@
+require 'pathname'
+require 'find'
+require 'active_support/inflector'
+require 'active_record'
+require 'json'
+
+def active_finite sym
+  anon = Class.new ActiveRecord::Base
+  klass = Object.const_set(sym.to_s.singularize.capitalize, anon)
+  klass
+end
+
+def create_finite args
+  modify_finite args do |vs, klass, column_name|
+    vs.each do |v|
+      obj = klass.new
+      obj.send column_name.to_s + '=', v
+      obj.save
+    end
+  end
+end
+
+def drop_finite args
+  modify_finite args do |vs, klass, column_name|
+    vs.each do |v|
+      objs = klass.where column_name => v
+      objs.each do |o|
+        klass.destroy o
+      end
+    end
+  end
+end
+
+def modify_finite args
+  table_name = args[:in_table]
+  if table_name.nil?
+    raise 'A table name must be specified for :in_table .'
+  end
+  file_name   = args[:from_file] 
+  values      = args[:values]
+  column_name = args[:column_name] || :value
+  if values.nil? and file_name.nil?
+    raise 'Either :from_file or :values must be specified.'
+  end
+
+  to_be_modified = Array.new
+  if not values.nil?
+    to_be_modified = to_be_modified.concat values
+  end
+
+  if not file_name.nil?
+    to_be_modified = to_be_modified.concat JSON.load open file_name
+  end
+
+  klass = active_finite table_name
+  yield to_be_modified, klass, column_name
+end
+
+def default_column_name
+  :value
+end

data/spec/active_finite_spec.rb

@@ -0,0 +1,82 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => ':memory:',
+  :pool     => 5,
+  :timeout  => 5000)
+
+  describe 'active_finite' do
+    it 'returns a class that is a child of active record base' do
+      active_finite(:test).superclass.should eql ActiveRecord::Base
+    end
+    it 'properly singularizes its classes' do
+      active_finite(:users).should eql User
+      active_finite(:foxes).should eql Fox
+      active_finite(:sheep).should eql Sheep
+    end
+  end
+
+  describe 'create_finite' do
+    it 'adds finites as rows to the database' do
+      ActiveRecord::Schema.define do
+        create_table :colors do |t|
+          t.string default_column_name, :null => false
+        end
+      end
+      finites = ['red', 'blue', 'green']
+      create_finite in_table: :colors, values: finites
+
+      finites.each do |f|
+        Color. where(default_column_name => f).should_not nil
+      end
+    end
+
+    it 'can change the column name' do
+      ActiveRecord::Schema.define do
+        create_table :characters do |t|
+          t.string :column_name, :null => false
+        end
+      end
+      finites = ['mickey', 'donald', 'scrooge']
+
+      create_finite in_table: :characters, 
+        values: finites, 
+        column_name: :column_name
+
+      finites.each do |f|
+        Color.where(:column_name => f).should_not nil
+      end
+    end
+
+    it 'can load from a json file' do
+      ActiveRecord::Schema.define do
+        create_table :villans do |t|
+          t.string default_column_name, :null => false
+        end
+      end
+      file_path = File.expand_path(File.dirname(__FILE__) + '/villans.json')
+      create_finite in_table: :villans,
+        from_file: file_path
+
+      ['scaramanga', 'no', 'janus'].each do |v|
+        Villan.where(default_column_name => v).should_not nil
+      end
+    end
+  end
+
+  describe 'drop_finite' do
+    it 'can delete previously added finites' do
+      ActiveRecord::Schema.define do
+        create_table :adjs do |t|
+          t.string default_column_name, :null => false
+        end
+
+        create_finite in_table: :adj, values: ['delete', 'drop']
+        drop_finite in_table: :adj, values: ['delete']
+        Adj.where(default_column_name => 'delete').should nil
+        Adj.where(default_column_name => 'drop').should_not nil
+      end
+    end
+  end
+

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'active_finite'
+require 'active_support/core_ext'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/villans.json

@@ -0,0 +1,2 @@
+["scaramanga", "no", "janus"]
+

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: active_finite
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- me
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-12 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: longer description of your gem
+email: me@stuffihavemade.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- active_finite.gemspec
+- lib/active_finite.rb
+- spec/active_finite_spec.rb
+- spec/spec_helper.rb
+- spec/villans.json
+has_rdoc: true
+homepage: http://github.com/r4pdevteam/active_finite
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 192715187
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: one-line summary of your gem
+test_files: 
+- spec/active_finite_spec.rb
+- spec/spec_helper.rb