static-data 0.2.0 → 0.3.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.3.0
+
+* Add a rails generator for creating a new static data model.
+* Update docs to demonstrate `update` rake task and new generator.
+
 # 0.2.0
 
 * Add support for incrementally updating tables rather than merely deleting all 

data/README.md

@@ -6,9 +6,9 @@ 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.
 
-While you can use migrations to do this, you can't referencing models
-in migrations can get you into trouble, and it can be awkward to 
-update static data in migrations later.
+While you can use migrations to do this, referencing models in migrations 
+can get you into trouble, and it can be awkward to update static data in 
+migrations later.
 
 It doesn't do much, but it's awfully handy to have a simple way of
 adding lookup table data to your database. And with StaticData, you 
@@ -29,19 +29,42 @@ Or install it yourself as:
 
     $ gem install static-data
 
-## Usage
+## Setting up Static Data for a table
+
+### Using the Generator
+
+Run the generator with the name of the model you want to build static data for
+(in the example below, ImageType):
+
+    rails generate static_data:create ImageType
+
+### By Hand
 
 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. Implement two class methods, `columns`
-and `rows`. The `columns` method should return the names of the columns in the 
-order their data appears in the `rows`
+Create a file for the model that you want to store static data for, named 
+after the model. The class name should match the model name, but with the word
+"Static" prepended (eg: Static\<ModelName\>). Implement two class methods, 
+`columns` and `rows`. 
+
+    cat > db/static-data/image_type.rb <<EOF
+    # For a model named ImageType:
+    class StaticImageType < StaticData::Base
+      def self.columns
+      end
+
+      def self.row
+      end
+    end
+
+## Describe your Static Data
+
+The `columns` method should return the names of the columns in the order their 
+data appears in the `rows`
 
     # For a model named ImageType:
-    cat > db/static-data/image_type.rb <<EOF 
     class StaticImageType < StaticData::Base
       def self.columns
         [:name, :mime_type, :extension]
@@ -54,9 +77,14 @@ order their data appears in the `rows`
       ]
       end
     end
-    EOF
 
-Install your static data:
+## Getting Your Static Data into the Database
+
+Update your database with your static data:
+
+    rake static-data:update
+
+Or replace all existing data in the static data tables with your static data:
 
     rake static-data:install
 

data/lib/generators/static_data/create_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+require 'rails/generators/named_base'
+
+module StaticData
+  module Generators
+    class CreateGenerator < Rails::Generators::NamedBase
+      desc "This generator creates a static-data file at db/static-data/<file_name>"
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_initializer_file
+        template "static-data-subclass.erb", "db/static-data/#{file_name}.rb"
+      end
+    end
+  end
+end

data/lib/generators/static_data/templates/static-data-subclass.erb

@@ -0,0 +1,12 @@
+class Static<%= class_name %> < StaticData::Base
+  def self.columns
+    [:col1, :col2, :col3]
+  end
+
+  def self.rows
+    [
+      ['col1value1', 'col2value1', 'col3value1'],
+      ['col1value2', 'col2value2', 'col3value2'],
+    ]
+  end
+end

data/lib/static-data/railtie.rb

@@ -1,6 +1,6 @@
 require 'static-data'
 require 'rails'
-module YourGem
+module StaticData
   class Railtie < Rails::Railtie
     rake_tasks do
       require 'rake'

data/lib/static-data/tasks.rake

@@ -27,7 +27,7 @@ namespace "static-data" do
 
     StaticData.static_data_classes(Rails.root) do |static_data_class|
       StaticData.report_duration("== #{static_data_class}: updating", 
-          "== #{static_data_class}: updating (%0.4fs)") do
+          "== #{static_data_class}: updated (%0.4fs)") do
 
         StaticData.report_duration("-- update", "   -> %0.4fs") do
           results = static_data_class.update

data/lib/static-data/version.rb

@@ -1,3 +1,3 @@
 module StaticData
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: static-data
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-20 00:00:00.000000000 Z
+date: 2013-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -88,6 +88,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/static_data/create_generator.rb
+- lib/generators/static_data/templates/static-data-subclass.erb
 - lib/static-data.rb
 - lib/static-data/base.rb
 - lib/static-data/railtie.rb