static-data 0.1.1 → 0.2.0

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# 0.2.0
+
+* Add support for incrementally updating tables rather than merely deleting all 
+data and rewriting. This should play nicer with foreign key constraints on
+static data tables, which, after all, is one of the main reasons to use a static
+data table in the first place. Use the new rake task `static-data:update`.
+
+# 0.1.1
+
+* Add rdocs for StaticData::Base
+* Update homepage to github location in gemspec

data/README.md

@@ -6,10 +6,14 @@ 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.
+
 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.
+adding lookup table data to your database. And with StaticData, you 
+can easily add new data and make it easy for to get everyone's 
+database in sync with the latest static data (even production).
 
 ## Installation
 
@@ -32,7 +36,9 @@ 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:
+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`
 
     # For a model named ImageType:
     cat > db/static-data/image_type.rb <<EOF 
@@ -58,18 +64,8 @@ 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.
+StaticData isn't designed for large volumes of data and performance may be poor
+on large static data sets.
 
 ## Contributing
 

data/lib/static-data.rb

@@ -3,4 +3,30 @@ require "static-data/base"
 require "static-data/railtie" if defined?(Rails)
 
 module StaticData
+
+  def self.report_duration(step_name, report_format)
+    puts step_name
+    start = Time.now
+    yield
+    puts report_format % [Time.now - start]
+  end
+
+  def self.static_data_classes(root)
+    static_data_class_files(root).each do |file|
+      basename = File.basename(file).split('.', 2).first
+      expected_class_name = "Static" + basename.camelize
+
+      require File.join(root, 'db', 'static-data', basename)
+
+      klass = Object.const_get(expected_class_name)
+      yield klass
+    end
+  end
+
+  private
+
+  def self.static_data_class_files(root)
+    Dir.glob(File.join(root, 'db', 'static-data', '*.rb')).sort
+  end
+
 end

data/lib/static-data/base.rb

@@ -41,9 +41,28 @@ module StaticData
       self.rows.each do |row|
         row_class.create!(Hash[cols.zip(row)], :without_protection => true)
       end
+      return {:created => self.rows.size}
     end
 
-    # def self.update
-    # end
+    # Creates new records for all of the data returned by the `rows` method
+    # of the StaticData subclass -- unless they exist already.
+    def self.update
+      created = 0
+      existing = 0
+      cols = self.columns
+      row_class = self.model_class
+      self.rows.each do |row|
+        attribs = Hash[cols.zip(row)]
+        row_class.transaction do
+          if row_class.exists?(attribs)
+            existing += 1
+          else
+            row_class.create!(attribs, :without_protection => true)
+            created += 1
+          end
+        end
+      end
+      return {:created => created, :existing => existing}
+    end
   end
 end

data/lib/static-data/tasks.rake

@@ -1,31 +1,42 @@
 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)]
+    StaticData.static_data_classes(Rails.root) do |static_data_class|
+      StaticData.report_duration("== #{static_data_class}: installing", 
+          "== #{static_data_class}: installed (%0.4fs)") do
+
+        StaticData.report_duration("-- reset", "   -> %0.4fs") do
+          static_data_class.reset
+        end        
+
+        StaticData.report_duration("-- install", "   -> %0.4fs") do
+          static_data_class.install
+        end
+      end
+
+      puts    # add blank line separator
+    end
+  end
+
+  desc "Update any missing static data table rows from db/static-data"
+  task :update => :environment do
+    require "static-data"
+
+    StaticData.static_data_classes(Rails.root) do |static_data_class|
+      StaticData.report_duration("== #{static_data_class}: updating", 
+          "== #{static_data_class}: updating (%0.4fs)") do
+
+        StaticData.report_duration("-- update", "   -> %0.4fs") do
+          results = static_data_class.update
+          puts "   -> existing: #{results[:existing]}; added: #{results[:created]}"
+        end
       end
 
-      puts "== #{expected_class_name}: installed (%0.4fs)" % [(Time.now - start)]
-      puts
+      puts    # add blank line separator
     end
   end
+
 end

data/lib/static-data/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: static-data
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -83,6 +83,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md