phil_columns 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f2e5f91da147995e312530fb811dc3ff34871c3
-  data.tar.gz: a8ed23b4ce9daecc5365212c0abb315c3183a7ae
+  metadata.gz: d789fc3c03e3480119e3beff9827ade6e9a1400f
+  data.tar.gz: 247007881ff42be0a715b6d880beefda0ced5baa
 SHA512:
-  metadata.gz: ee4bf29e129c603dd4b7e72c4d32832f785a682a2ad98bf4aa76654fefdb57aef7015acc70a350c0287961c826f74d6e158343005d02cc8f707a16b69e61a352
-  data.tar.gz: 03f90d08be6e33b587e49494ebf1959f5668cba01e2a17c3d72b10b5ac1a705db86a3f9a7e8919fd6e0fa21c2c47f32f7557d8fdeff98d3e5115ba55f9f6b728
+  metadata.gz: 6979d9a76ee6a732e66ccb95e2c4fa13d427908b6eb65f23d826aa28e9bea165e07c088b7f6898ec8578f8152260930ba5755bab6264e93faf3d33eb50127683
+  data.tar.gz: c965c6209b0dbed143f66e50915ba72b6424f3eb43b4218f8e50b2912a40e185f8efe47e79bae46627829ca2a75ce9f615df8db4678181e9230ecfa5af03cc6d

data/README.md

@@ -244,16 +244,19 @@ To specify a seed for production, simply add production to the specified environ
 
 ### The Configuration File
 
-The configuration file is in YAML format.
+The configuration file is in YAML format.  The following configuraiton file is the default configuration for a Rails project.
 
     ---
     default_tags:
     - default
     env_files:
     - config/environment
+    - config/phil_columns
     schema_load_strategy: load
     schema_unload_strategy: drop
     seeds_path: db/seeds
+    skip_tables_on_purge:
+    - ncite_fake_vetting_responses
 
 #### Configuration Attributes
 
@@ -279,8 +282,65 @@ the environment file(s) from a framework, such as Rails.
 
 [String] The relative path to the seeds directory.
 
+##### skip_tables_on_purge
+
+[String] A list of tables to skip when purging.
+
+
+### DRYing Seeds Up
+
+#### Rails Project
+
+As your seed set grows you will certainly have opportunities to DRY up your seeds with utility methods, etc.  The best way to accomplish this is to add
+code to the config/phil_columns.rb (Rails specific).  One possibility is to define modules to use as mix-ins to the seeds.
+
+    # Add any Phil Columns only configuration in this file
+
+    Rails.logger.level = Logger::WARN #minimize log output during seeding
+
+    module ThingHelper
+      def create_thing( name )
+        Thing.create! name: name
+      end
+    end
+
+To use the code in a seed simply include the module.
+
+    class AddThings < PhilColumns::Seed
+      include ThingHelper
+
+      def up
+        create_thing( 'toy' )
+      end
+    end
+
+#### Plain-Old Ruby Project
+
+The same concepts applied above to a Rails project apply to a Ruby project.  The only difference is specifying an environment file in the configuration 
+file: .phil\_columns.  The env_files attribute takes an array of files to load.  Simply provide a relative path to the file from the project root and place
+the common code into one or more files.
+
+    ---
+    ...
+    env_files:
+    - some/environment/file
+    - another/environment/file
+    ...
+
+
+### The Console
+
+Phil columns has a built in console that loads up the seeding environment and any helpers defined in the Seeds module.
+
+    $ phil-columns console
+
 
 ## Adapters and Extensions
 
 * [phil_columns-activerecord](https://github.com/midas/phil_columns-activerecord)
 * [phil_columns-factory_girl](https://github.com/midas/phil_columns-factory_girl)
+
+
+## Contributors
+
+* Nils Jonsson [njonsson](https://github.com/njonsson)

data/lib/phil_columns/cli.rb

@@ -53,6 +53,15 @@ module PhilColumns
       version is not included in the set.)
     end
 
+    desc "console", "Load a console with seeding assets available"
+    long_desc <<-LONGDESC
+      #{env_option_description}
+    LONGDESC
+    env_option
+    def console
+      execute PhilColumns::Command::Console
+    end
+
     desc "purge", "Purge all data from tables"
     long_desc <<-LONGDESC
       Purges all tables excluding any project metadata tables, ie. schema_migrations when using ActiveRecord.

data/lib/phil_columns/command.rb

@@ -2,6 +2,7 @@ module PhilColumns
   module Command
 
     autoload :Base,      'phil_columns/command/base'
+    autoload :Console,   'phil_columns/command/console'
     autoload :Generate,  'phil_columns/command/generate'
     autoload :Generator, 'phil_columns/command/generator'
     autoload :Install,   'phil_columns/command/install'

data/lib/phil_columns/command/console.rb

@@ -0,0 +1,29 @@
+module PhilColumns
+  module Command
+    class Console < Base
+
+      def execute
+        load_environment
+        load_seed_helpers
+        start_console
+      end
+
+    protected
+
+      def start_console
+        require 'irb'
+        IRB.start
+      end
+
+      def load_seed_helpers
+        if defined?( Seeds )
+          Seeds::constants.each do |const_name|
+            konstant = Seeds::const_get(const_name)
+            Object.send( :include, konstant )
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/phil_columns/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phil_columns
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - JC. ason Harrelson (midas)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-30 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,6 +151,7 @@ files:
 - lib/phil_columns/cli/reset.rb
 - lib/phil_columns/command.rb
 - lib/phil_columns/command/base.rb
+- lib/phil_columns/command/console.rb
 - lib/phil_columns/command/generate.rb
 - lib/phil_columns/command/generate/seed.rb
 - lib/phil_columns/command/generator.rb