static-data 0.1.0 → 0.1.1

data/lib/static-data/base.rb

@@ -1,22 +1,44 @@
 module StaticData
   class Base
+    # Overrides the default model class for this StaticData class. Use this
+    # if your StaticData class name is not "Static + ModelClass". If you stick
+    # to the standard naming convention, you don't need this method.
     def self.set_model_class(other_model_class)
       @model_class_name = other_model_class
     end
 
+    # Returns the model class for this StaticData subclass (which is the class
+    # name without the "Static" prefix by default, but can be overridden via
+    # set_model_class).
     def self.model_class
       model_class_name = @model_class_name || self.name.sub(/^Static/, '')
       Object.const_get(model_class_name)
     end
 
+    # Deletes all model_class records from the database.
     def self.reset
       self.model_class.delete_all
     end
 
+    # Override this method to control which attributes make up the data
+    # returned by the `rows` method.
+    def self.columns
+      []
+    end
+
+    # Override this method to return the record data that should always exist
+    # in the model class's database table. The columns must appear in the 
+    # the order specified by the `columns` method.
+    def self.rows
+      []
+    end
+
+    # Creates new records for all of the data returned by the `rows` method
+    # of the StaticData subclass.
     def self.install
       cols = self.columns
       row_class = self.model_class
-      rows.each do |row|
+      self.rows.each do |row|
         row_class.create!(Hash[cols.zip(row)], :without_protection => true)
       end
     end

data/lib/static-data/version.rb

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

data/static-data.gemspec

@@ -7,13 +7,13 @@ Gem::Specification.new do |spec|
   spec.name          = "static-data"
   spec.version       = StaticData::VERSION
   spec.authors       = ["Ben Turner"]
-  spec.email         = ["bjturner@outofcoffee.com"]
+  spec.email         = ["codewrangler@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.homepage      = "https://github.com/kindjar/static-data"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: static-data
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -77,7 +77,7 @@ dependencies:
         version: '2.6'
 description: ! "Rails plugin to manage static data in ActiveRecord \n      models/tables"
 email:
-- bjturner@outofcoffee.com
+- codewrangler@outofcoffee.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -94,7 +94,7 @@ files:
 - lib/static-data/version.rb
 - spec/static_data_spec.rb
 - static-data.gemspec
-homepage: ''
+homepage: https://github.com/kindjar/static-data
 licenses:
 - MIT
 post_install_message: