active_finite 0.1.3 → 0.1.4

data/README.rdoc

@@ -15,32 +15,30 @@ Let's start by defining a simple migration:
 
   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']
+      add_finites in_table: :hellos, values: ['oy', 'que tal', 'hi']
     end
 
     self.down
-      drop_finite in_table: :hellos, values: ['oy', 'que tal', 'hi']
-      drop_table :hellos
+      delete_finites in_table: :hellos, values: ['oy', 'que tal', 'hi']
     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
+  hellos = get_finite_table :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.
+
+We can also a collection of all of the active record classes defined by
+active_finite by using:
+  all_finite_tables
+
+Using get_finite_table and all_finite_tables implicitly bring the associated
+classes into scope, so a single call to all_finite_tables is sufficent to 
+define all of the models.
 
 == 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
+If the column name must be different than the default, 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:
 
@@ -49,22 +47,21 @@ the migration. For example:
   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'
+      add_finites 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
+      delete_finites in_table: :hellos, values: all
     end
   end
 
 If both values and from_file are defined, active_finite will pull entries from both.
+Another option to be aware of is that values do not have to be explicitly listed
+upon deletion, using the all option is sufficent.
+
 
 == Other ideas
 Combine active_finite with foreigner[https://github.com/matthuhiggins/foreigner] to put foreign key constraints on users of defined enums.

data/Rakefile

@@ -13,11 +13,10 @@ 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/stuffihavemade/active_finite"
+  gem.homepage = "http://github.com/r4pdevteam/active_finite"
   gem.license = "MIT"
-  gem.summary = %Q{An ActiveRecord addon for enums, based on DRY and that enums
-  should be database columns}
-  gem.description = %Q{see README.rdoc}
+  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,

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/lib/active_finite.rb

@@ -4,13 +4,68 @@ require 'active_support/inflector'
 require 'active_record'
 require 'json'
 
-def active_finite sym
-  anon = Class.new ActiveRecord::Base
-  Object.const_set(sym.to_s.singularize.capitalize, anon)
+def get_finite_table sym, *args
+  class_name = as_class_name sym
+  class_not_defined = not(Object.const_defined? class_name)
+  should_force = args.any? {|x| x == :force}
+  if class_not_defined or should_force
+    anon = Class.new ActiveRecord::Base
+    Object.const_set class_name, anon
+  else
+    Object.const_get class_name
+  end
+end
+
+def as_class_name table_name
+  table_name.to_s.singularize.capitalize.to_sym
+end
+
+def all_finite_tables
+  master = get_finite_table(master_table_name)
+  if master.table_exists?
+    master
+    .where("#{default_column_name} != ?", master_table_name)
+    .collect {|x| x.send default_column_name.to_s}
+    .collect {|x| get_finite_table x}
+  else
+    []
+  end
+end
+
+def master_table_name
+  :active_finites
+end
+
+def add_to_master table_name
+  add_finites in_table: master_table_name, values: [table_name]
+end
+
+def delete_from_master table_name
+  delete_finites in_table: master_table_name, values: [table_name]
 end
 
-def create_finite args
+def is_in_master_table? table_name
+  if table_name.eql? master_table_name
+    true
+  else
+    get_finite_table(master_table_name)
+    .where("#{default_column_name} != ?", master_table_name)
+    .where("#{default_column_name} == ?", table_name)
+    .any?
+  end
+end
+
+
+def add_finites args
   modify_finite args do |vs, klass, column_name|
+    if not klass.table_exists?
+      ActiveRecord::Schema.define do
+        create_table klass.table_name do |t|
+          t.string column_name, :null => false
+        end
+      end
+      add_to_master klass.table_name
+    end
     vs.each do |v|
       obj = klass.new
       obj.send column_name.to_s + '=', v
@@ -19,13 +74,30 @@ def create_finite args
   end
 end
 
-def drop_finite args
+def delete_finites args,
+  delete_all = args[:values] == :all
+  if delete_all
+    args[:values] = []
+  end
   modify_finite args do |vs, klass, column_name|
-    vs.each do |v|
-      objs = klass.where column_name => v
-      objs.each do |o|
+    if delete_all
+      klass.all.each do |o|
         klass.destroy o
       end
+    else
+      vs.each do |v|
+        objs = klass.where column_name => v
+        objs.each do |o|
+          klass.destroy o
+        end
+      end
+    end
+    if klass.count.eql? 0
+      ActiveRecord::Schema.define do
+        drop_table klass.table_name
+      end
+      delete_from_master klass.table_name
+      Object.send 'remove_const', klass.to_s.to_sym
     end
   end
 end
@@ -51,7 +123,7 @@ def modify_finite args
     to_be_modified = to_be_modified.concat JSON.load open file_name
   end
 
-  klass = active_finite table_name
+  klass = get_finite_table table_name
   ActiveRecord::Base.transaction do
     yield to_be_modified, klass, column_name
   end

data/spec/active_finite_spec.rb

@@ -1,97 +1,138 @@
 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
+def reconnect
+  ActiveRecord::Base.establish_connection(
+    :adapter  => 'sqlite3',
+    :database => ':memory:',
+    :pool     => 5,
+    :timeout  => 5000)
+end
+
+describe 'get_finite_table' do
+  before :each do
+    reconnect
+  end
+  it 'returns a class that is a child of active record base' do
+    get_finite_table(:test).superclass.should eql ActiveRecord::Base
+  end
+  it 'brings a class into scope' do
+    get_finite_table :spaces
+    Object.const_defined?(:Space).should be true
   end
+  it 'will not redefine a previously defined constant' do
+    Define = true
+    get_finite_table :defines
+    Define.should == true
+  end
+  it 'will redefine a previously defined constant with the force option' do
+    Anyway = true
+    get_finite_table :anyways, :force
+    Anyway.should_not == true
+  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
+describe 'all_finite_tables' do
+  before :each do
+    reconnect
+  end
+  it 'returns all active record classes created by active_finite' do
+    add_finites in_table: :things, values: ['1']
+    add_finites in_table: :stuffs, values: ['s']
+    all_finite_tables.should == [Thing, Stuff]
+  end
+  it 'will no longer return a removed finite table' do
+    add_finites in_table: :things, values: ['1']
+    delete_finites in_table: :things, values: ['1']
+    all_finite_tables.should == []
+  end
+end
 
-      finites.each do |f|
-        Color.where(default_column_name => f).should_not nil
-      end
+describe 'as_class_name' do
+  before :each do
+    reconnect
+  end
+  it 'capitalizes its input' do
+    as_class_name(:as).should eql :A
+  end
+  it 'properly singularizes its input' do
+    as_class_name(:users).should eql :User
+    as_class_name(:foxes).should eql :Fox
+    as_class_name(:sheep).should eql :Sheep
+  end
+end
+
+describe 'add_finites' do
+  before :each do
+    reconnect
+  end
+  it 'adds finites as rows to the database' do
+    finites = ['red', 'blue', 'green']
+    add_finites 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']
+  it 'creates the coresponding table if it doesn\`t exist' do
+    add_finites in_table: :tests, values: [1]
+    Object.const_defined?(:Test).should be true
+  end
 
-      create_finite in_table: :characters, 
-        values: finites, 
-        column_name: :column_name
+  it 'can use a different column name' do
+    finites = ['mickey', 'donald', 'scrooge']
+    add_finites in_table: :characters, 
+      values: finites, 
+      column_name: :column_name
 
-      finites.each do |f|
-        Color.where(:column_name => f).should_not nil
-      end
+    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
+  it 'can load from a json file' do
+    file_path = File.expand_path(File.dirname(__FILE__) + '/villans.json')
+    add_finites in_table: :villans,
+      from_file: file_path
 
-      ['scaramanga', 'no', 'janus'].each do |v|
-        Villan.where(default_column_name => v).should_not nil
-      end
+    ['scaramanga', 'no', 'janus'].each do |v|
+      Villan.where(default_column_name => v).should_not nil
     end
+  end
 
-    it 'will fail atomically' do
-      ActiveRecord::Schema.define do
-        create_table :wu_members do |t|
-          t.string default_column_name, :null => false
-        end
-      end
-      begin
-        create_finite in_table: :wu_members, values: ['rza', 'gza', nil]
-      rescue
-        ['rza', 'gza'].each do |w|
-          active_finite(:wu_members).where(default_column_name => w).should nil
-        end
+  it 'will fail atomically' do
+    begin
+      add_finites in_table: :wu_members, values: ['rza', 'gza', nil]
+    rescue
+      ['rza', 'gza'].each do |w|
+        get_finite_table(:wu_members).where(default_column_name => w).should nil
       end
     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
+describe 'delete_finies' do
+  before :each do
+    reconnect
+  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
+  it 'can delete previously added finites' do
+    add_finites in_table: :adjs, values: ['delete', 'drop']
+    delete_finites in_table: :adjs, values: ['delete']
+    Adj.where(default_column_name => 'delete').should nil
+    Adj.where(default_column_name => 'drop').should_not nil
+  end
+
+  it 'will remove the table if there are no finites left' do
+    add_finites in_table: :deletes, values: ['delete']
+    delete_finites in_table: :deletes, values: ['delete']
+    Object.const_defined?(:Delete).should_not be true
+  end
+
+  it 'can delete all values with the all option' do
+    add_finites in_table: :adjs, values: ['delete', 'drop']
+    delete_finites in_table: :adjs, values: :all
+    Object.const_defined?(:Adj).should_not be true
   end
+end
 

metadata

@@ -2,7 +2,7 @@
 name: active_finite
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - me
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-12 00:00:00 -04:00
+date: 2011-04-21 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -79,7 +79,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id006
-description: see README.rdoc
+description: longer description of your gem
 email: me@stuffihavemade.com
 executables: []
 
@@ -100,7 +100,7 @@ files:
 - spec/spec_helper.rb
 - spec/villans.json
 has_rdoc: true
-homepage: http://github.com/stuffihavemade/active_finite
+homepage: http://github.com/r4pdevteam/active_finite
 licenses: 
 - MIT
 post_install_message: 
@@ -113,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -927353165
+      hash: 138921425
       segments: 
       - 0
       version: "0"
@@ -129,7 +129,7 @@ rubyforge_project:
 rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
-summary: An ActiveRecord addon for enums, based on DRY and that enums should be database columns
+summary: one-line summary of your gem
 test_files: 
 - spec/active_finite_spec.rb
 - spec/spec_helper.rb