static-data 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Benjamin Turner
+
+MIT License
+
+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,80 @@
+# StaticData
+
+StaticData is a Rails plugin that lets you easily manage fixed data 
+that you want to always have in your database, and is primarily 
+useful for pre-populating lookup tables and the like. It consists of 
+a simple framework for describing your static data and a Rake task 
+for ensuring that your static data is installed in your database.
+
+It doesn't do much, but it's awfully handy to have a simple way of
+adding lookup table data to your database. Anything that makes it 
+easier to set up a brand new database from scratch is a win in my
+book.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'static-data'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install static-data
+
+## Usage
+
+Create a db/static-data directory in your app:
+
+    mkdir db/static-data
+
+Create a file for each model that you want to store static for. The
+file should be named after the model:
+
+    # For a model named ImageType:
+    cat > db/static-data/image_type.rb <<EOF 
+    class StaticImageType < StaticData::Base
+      def self.columns
+        [:name, :mime_type, :extension]
+      end
+
+      def self.row
+      [
+        ['PNG', 'image/png', 'png'],
+        ['JPEG', 'image/jpeg', 'jpg'],
+      ]
+      end
+    end
+    EOF
+
+Install your static data:
+
+    rake static-data:install
+
+Enjoy!
+
+## Limitations
+
+The current static-data:install task blows away any existing data 
+already present in the model's table before installing, so any
+non-static data in the table will be nuked. It would be nice to 
+offer another task that simply ensures that all static data is
+present without deleting other data. I consider that a TODO, but
+am happy to receive pull requests.
+
+If you have existing data in your tables and use foreign key 
+constraints (which do go hand-in-hand with lookup tables), you
+probably don't want to run this rake task, because it will either 
+fail or cause delete cascades, depending on how you've set up your
+constraints. Fixing the above item should hopefully fix this, too.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/static-data.rb

@@ -0,0 +1,6 @@
+require "static-data/version"
+require "static-data/base"
+require "static-data/railtie" if defined?(Rails)
+
+module StaticData
+end

data/lib/static-data/base.rb

@@ -0,0 +1,27 @@
+module StaticData
+  class Base
+    def self.set_model_class(other_model_class)
+      @model_class_name = other_model_class
+    end
+
+    def self.model_class
+      model_class_name = @model_class_name || self.name.sub(/^Static/, '')
+      Object.const_get(model_class_name)
+    end
+
+    def self.reset
+      self.model_class.delete_all
+    end
+
+    def self.install
+      cols = self.columns
+      row_class = self.model_class
+      rows.each do |row|
+        row_class.create!(Hash[cols.zip(row)], :without_protection => true)
+      end
+    end
+
+    # def self.update
+    # end
+  end
+end

data/lib/static-data/railtie.rb

@@ -0,0 +1,10 @@
+require 'static-data'
+require 'rails'
+module YourGem
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      require 'rake'
+      load 'static-data/tasks.rake'
+    end
+  end
+end

data/lib/static-data/tasks.rake

@@ -0,0 +1,31 @@
+namespace "static-data" do
+  desc "Install all static data from db/static-data"
+  task :install => :environment do
+    require "static-data"
+
+    Dir.glob('db/static-data/*') do |file|
+      basename = File.basename(file).split('.', 2).first
+      expected_class_name = "Static" + basename.
+          camelize
+
+      start = Time.now
+      puts "== #{expected_class_name}: installing"
+
+      require "#{Rails.root}/db/static-data/#{basename}"
+      Object.const_get(expected_class_name).tap do |static_data_class|
+        step_start = Time.now
+        puts "-- reset"
+        static_data_class.reset
+        puts "   -> %0.4fs" % [(Time.now - step_start)]
+
+        step_start = Time.now
+        puts "-- install"
+        static_data_class.install
+        puts "   -> %0.4fs" % [(Time.now - step_start)]
+      end
+
+      puts "== #{expected_class_name}: installed (%0.4fs)" % [(Time.now - start)]
+      puts
+    end
+  end
+end

data/lib/static-data/version.rb

@@ -0,0 +1,3 @@
+module StaticData
+  VERSION = "0.1.0"
+end

data/spec/static_data_spec.rb

@@ -0,0 +1,21 @@
+require 'static-data'
+
+describe StaticData::Base do
+  it "model_class returns class without Static in it" do
+    class FooBar; end
+    class StaticFooBar < StaticData::Base; end
+
+    class_obj = Object.const_get('StaticFooBar')
+    class_obj.model_class.should eql(FooBar)
+  end
+
+  it 'model_class returns alternate class if set_model_class is used' do
+    class Bazzle; end
+    class StaticFooBar < StaticData::Base
+      set_model_class 'Bazzle'
+    end
+
+    class_obj = Object.const_get('StaticFooBar')
+    class_obj.model_class.should eql(Bazzle)
+  end
+end

data/static-data.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'static-data/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "static-data"
+  spec.version       = StaticData::VERSION
+  spec.authors       = ["Ben Turner"]
+  spec.email         = ["bjturner@outofcoffee.com"]
+  spec.description   = %q{Rails plugin to manage static data in ActiveRecord 
+      models/tables}
+  spec.summary       = %q{StaticData is a Rails plugin that lets you easily 
+      manage fixed data that you want to always have in your database, and 
+      is primarily useful for pre-populating lookup tables and the like.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rake"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.6"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: static-data
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ben Turner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: ! "Rails plugin to manage static data in ActiveRecord \n      models/tables"
+email:
+- bjturner@outofcoffee.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/static-data.rb
+- lib/static-data/base.rb
+- lib/static-data/railtie.rb
+- lib/static-data/tasks.rake
+- lib/static-data/version.rb
+- spec/static_data_spec.rb
+- static-data.gemspec
+homepage: ''
+licenses:
+- MIT
+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.23
+signing_key: 
+specification_version: 3
+summary: StaticData is a Rails plugin that lets you easily  manage fixed data that
+  you want to always have in your database, and  is primarily useful for pre-populating
+  lookup tables and the like.
+test_files:
+- spec/static_data_spec.rb