config_scripts 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f9ab8bf09440a9182b9450651756d9cdde28109
-  data.tar.gz: ab9ff7ebde2313fee3071c9dcff710219cc1d3bf
+  metadata.gz: e43b011ea638d24011c4495dcc7cb6f99dc15f8b
+  data.tar.gz: 3c10e0d558764fdedacc7230b806b3a9ca412b69
 SHA512:
-  metadata.gz: c51d874865f2080a14ee8a13576b828fbdf8dd5935e32b1311384b276a16816b3d18283da8fb97c0dda8b0bf81f9dd5dc9ae136fa67dd97aaa4341dc2f4516e9
-  data.tar.gz: 13a589c68a9ce1d9a9b44aa00bf8593aade3c1d10e3bc72051226a65ad69e1d08015901c33f47efffc522548210c4973650b149b2b9a5624709e97cba6aa103f
+  metadata.gz: d9fd12eb8e2e31a9d96b4ca1f6935b69ea1f0d49da67766462dc91a624fcecbf1a7f316a6058d762770fb4f342c7e5e98c0e366dcb0ca9eb949ee504aee8fe09
+  data.tar.gz: 37bc6fc893f4cc022b5db7dfb4941924ac77ae3574df356c8df5383860587f99a519b171acdfe63b1b208770ec7734faa6df37f9003add2d975f8197b76d4741

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# Version 0.4.2 - 3 March 2014
+
+* Outputs the seed filename when we fail to load a seed
+* Adds support for running and rolling back individual config scripts.
+
+# Version 0.4.1 - 15 February 2014
+
+* Bug fixes with the gem spec
+
 # Version 0.4.0 - 9 February 2014
 
 * Adds support for polymorphic foreign keys

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    config_scripts (0.4.1)
+    config_scripts (0.4.2)
       rails (> 3.0.0)
 
 GEM

data/README.md

@@ -27,29 +27,4 @@ And run them:
 
 ## Usage
 
-### Config Scripts
-
-#### Generate a new config script:
-
-    $ rails g config_scripts:config_script MyConfigScript
-
-This will add a file to the `db/config_scripts` directory.
-
-#### Run all the pending config scripts:
-
-    $ rake config_scripts:run_pending
-
-### Seed Data
-
-#### Defining Seed Data:
-
-Create a file in the directory `db/seeds/definitions`. Examples of defining seed
-data will be coming in the future.
-
-#### Dumping seed data to the disk:
-
-    $ rake config_scripts:seeds:dump
-
-#### Loading the seed data from the disk:
-
-    $ rake config_scripts::seeds::load
+See [the wiki](https://github.com/brownleej/config-scripts-gem/wiki) for usage examples.

data/lib/config_scripts/scripts/script.rb

@@ -35,19 +35,7 @@ module ConfigScripts
       # @return [True] 
       def self.run_pending_scripts
         self.pending_scripts.each do |filename|
-          path = Rails.root.join('db', 'config_scripts', "#{filename}.rb")
-          require path
-          timestamp = filename[0,14]
-          class_name = filename[15..-1].camelize + 'Config'
-          klass = nil
-          begin
-            klass = class_name.constantize
-          rescue NameError
-            puts "Aborting: could not find class #{class_name}"
-            return
-          end
-          puts "Running #{filename}"
-          success = klass.new(timestamp).run(:up)
+          self.run_file(filename)
         end
         true
       end
@@ -60,6 +48,47 @@ module ConfigScripts
         end
       end
 
+      # This method gets the script filename for a given class.
+      #
+      # This will convert the class name into the snake case format, and look
+      # for a filename that has a timestamp followed by that.
+      #
+      # @param [String] name
+      #   The name of the config script class, with the +Config+ suffix.
+      #
+      # @return [String] filename
+      #   The filename.
+      def self.filename_for_script(name)
+        name_underscore = name.underscore
+        paths = Dir.glob(File.join(self.script_directory, "*#{name_underscore}.rb"))
+        path = paths.select do |path|
+          path =~ Regexp.new("[\\d]+_#{name_underscore}.rb")
+        end.first
+        path = File.basename(path, ".rb") if path
+        path
+      end
+
+      # This method runs the script with a given filename.
+      #
+      # The file must be in the +db/config_scripts+ directory, and should the
+      # filename should not include the `+rb+ extension.
+      #
+      # @param [String] filename
+      #   The name of the file to run, without the extension.
+      #
+      # @param [Symbol] direction
+      #   Whether we should run the script +up+ or +down+.
+      def self.run_file(filename, direction=:up)
+        path = Rails.root.join('db', 'config_scripts', "#{filename}.rb")
+        require path
+        timestamp = filename[0,14]
+        class_name = filename[15..-1].camelize + 'Config'
+        klass = nil
+        klass = class_name.constantize
+        puts "Running #{filename} #{direction}"
+        success = klass.new(timestamp).run(direction)
+      end
+
       # @!group Creating
 
       # This method creates a new script.

data/lib/config_scripts/seeds/seed_type.rb

@@ -199,7 +199,13 @@ module ConfigScripts
               value = self.read_value_for_attribute(value, attribute)
               record.send("#{attribute}=", value)
             end
-            record.save!
+            
+            begin
+              record.save!
+            rescue
+              puts "#{self.filename}.csv"
+              raise
+            end
           end
         end
       end

data/lib/config_scripts/tasks.rb

@@ -5,7 +5,7 @@ module ConfigScripts
     railtie_name :config_sripts_rake_tasks
 
     rake_tasks do
-      load 'config_scripts/tasks/pending_migrations.rake'
+      load 'config_scripts/tasks/migrations.rake'
       load 'config_scripts/tasks/seeds.rake'
     end
   end

data/lib/config_scripts/tasks/migrations.rake

@@ -0,0 +1,23 @@
+namespace :config_scripts do
+  desc "Run pending config scripts"
+  task :run_pending => :environment do
+    ConfigScripts::Scripts::Script.run_pending_scripts
+  end
+
+  desc "List pending config scripts"
+  task :list_pending => :environment do
+    ConfigScripts::Scripts::Script.list_pending_scripts
+  end
+
+  desc "Run a config scripts"
+  task :run => :environment do
+    filename = ConfigScripts::Scripts::Script.filename_for_script(ENV['SCRIPT'])
+    ConfigScripts::Scripts::Script.run_file(filename)
+  end
+
+  desc "Rollback a config scripts"
+  task :rollback => :environment do
+    filename = ConfigScripts::Scripts::Script.filename_for_script(ENV['SCRIPT'])
+    ConfigScripts::Scripts::Script.run_file(filename, :down)
+  end
+end

data/lib/config_scripts/version.rb

@@ -1,4 +1,4 @@
 module ConfigScripts
   # The current version of the library.
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/spec/scripts/script_spec.rb

@@ -37,134 +37,130 @@ describe ConfigScripts::Scripts::Script do
     describe "run_pending_scripts" do
       class TestConfigScriptConfig < ConfigScripts::Scripts::Script; end
 
-      let!(:timestamp1) { '20140208150000' }
-      let!(:timestamp2) { '20140208200000' }
-      let!(:timestamp3) { '20140208250000' }
+      let(:script_filenames) { [double, double, double] }
 
-      let(:script_filenames) { [timestamp1, timestamp2, timestamp3].collect { |stamp| "#{stamp}_test_config_script" } }
+      before do
+        klass.stub pending_scripts: script_filenames
+        klass.stub :run_file
+      end
 
-      let!(:script1) { TestConfigScriptConfig.new(timestamp1) }
-      let!(:script2) { TestConfigScriptConfig.new(timestamp2) }
-      let!(:script3) { TestConfigScriptConfig.new(timestamp3) }
+      context "with no problems running the scripts" do
+        before do
+          klass.run_pending_scripts
+        end
+
+        it "runs the scripts" do
+          expect(klass).to have_received(:run_file).with(script_filenames[0])
+          expect(klass).to have_received(:run_file).with(script_filenames[1])
+          expect(klass).to have_received(:run_file).with(script_filenames[2])
+        end
+      end
+
+      context "with a problems running the scripts" do
+        before do
+          klass.stub(:run_file).with(script_filenames[1]).and_raise
+        end
+
+        it "raises an exception" do
+          expect(lambda{klass.run_pending_scripts}).to raise_exception
+        end
+
+        it "stops running the scripts when it hits the exception" do
+          klass.run_pending_scripts rescue nil
+          expect(klass).to have_received(:run_file).with(script_filenames[0])
+          expect(klass).to have_received(:run_file).with(script_filenames[1])
+          expect(klass).not_to have_received(:run_file).with(script_filenames[2])
+        end
+      end
+    end
+
+    describe "run_file" do
+      class TestConfigScriptConfig < ConfigScripts::Scripts::Script; end
+
+      let(:timestamp) { '20140208150000' }
+      let(:filename) { "#{timestamp}_test_config_script" }
+      let!(:script) { TestConfigScriptConfig.new(timestamp) }
+      let(:path) { Rails.root.join("db", "config_scripts", "#{filename}.rb") }
 
       before do
-        klass.stub pending_scripts: script_filenames
+        script.stub :run
+        TestConfigScriptConfig.stub new: script
         klass.stub :require
         klass.stub :puts
-        [script1, script2, script3].each do |script|
-          script.stub(:run)
+      end
+
+      context "with no problems running the scripts" do
+        before do
+          klass.run_file(filename, :sideways)
         end
 
-        TestConfigScriptConfig.stub(:new).with(timestamp1).and_return(script1)
-        TestConfigScriptConfig.stub(:new).with(timestamp2).and_return(script2)
-        TestConfigScriptConfig.stub(:new).with(timestamp3).and_return(script3)
+        it "requires the file" do
+          expect(klass).to have_received(:require).with(path)
+        end
 
-        FileUtils.mkdir_p(Rails.root.join("tmp", "cache"))
-      end
+        it "puts the name of the file out to the console" do
+          expect(klass).to have_received(:puts).with("Running #{filename} sideways")
+        end
 
-      let(:scripts) {[
-        {
-          filename: script_filenames[0],
-          script: script1,
-          run: true
-        },
-        {
-          filename: script_filenames[1],
-          script: script2,
-          run: true
-        },
-        {
-          filename: script_filenames[2],
-          script: script3,
-          run: true
-        }
-      ]}
-
-
-      shared_examples "ran scripts" do
-        it "requires only the scripts it needs to run" do
-          scripts.each do |script|
-            path = Rails.root.join("db", "config_scripts", "#{script[:filename]}.rb")
-            if script[:run]
-              expect(klass).to have_received(:require).with(path)
-            else
-              expect(klass).not_to have_received(:require).with(path)
-            end
-          end
+        it "creates a config script with the class and timestamp" do
+          expect(TestConfigScriptConfig).to have_received(:new).with(timestamp)
         end
 
-        it "creates a config script for each timestamp with the appropriate class" do
-          scripts.each do |script|
-            timestamp = script[:filename].first(14)
-            if script[:run]
-              expect(TestConfigScriptConfig).to have_received(:new).with(timestamp)
-            else
-              expect(TestConfigScriptConfig).not_to have_received(:new).with(timestamp)
-            end
-          end
+        it "calls the run command on the script with the direction" do
+          expect(script).to have_received(:run).with(:sideways)
         end
+      end
 
-        it "calls the up command on each script item" do
-          scripts.each do |script|
-            if script[:run]
-              expect(script[:script]).to have_received(:run).with(:up)
-            else
-              expect(script[:script]).not_to have_received(:run)
-            end
-          end
+      context "with a problem running the script" do
+        before do
+          script.stub(:run).and_raise 'error'
         end
 
-        it "outputs the name of the scripts that it is running" do
-          scripts.each do |script|
-            if script[:run]
-              expect(klass).to have_received(:puts).with("Running #{script[:filename]}")
-            else
-              expect(klass).not_to have_received(:puts).with("Running #{script[:filename]}")
-            end
-          end
+        it "re-raises the exception" do
+          expect(lambda{klass.run_file(filename)}).to raise_exception 'error'
         end
       end
 
-      context "with no problems running the scripts" do
-        it_behaves_like "ran scripts"
-
-        before do
-          klass.run_pending_scripts
+      context "with a problem finding the class" do
+        it "re-raises the exception" do
+          expect(lambda{klass.run_file("#{timestamp}_test_config_script_2")}).to raise_exception NameError
         end
       end
+    end
 
-      context "with a problems running the scripts" do
-        it_behaves_like "ran scripts"
+    describe "filename_for_script" do
+      let(:name) { 'my_change' }
+      let(:path) { File.join(klass.script_directory, "*#{name}.rb") }
+      let(:filename) { "1234512345_#{name}" }
+      subject { klass.filename_for_script(name) }
 
+      context "when there are multiple files that have the name" do
         before do
-          script2.stub(:run).and_raise 'Error in script'
-          scripts[2][:run] = false
-          begin
-            klass.run_pending_scripts
-          rescue
-          end
+          Dir.stub(:glob).with(path).and_return(["#{filename}.rb", "5123451234_#{name}.rb"])
         end
-      end
 
-      context "with a class name it cannot find" do
-        let(:bad_filename) { "20140208170000_missing_class" }
+        it "is the first one" do
+          expect(subject).to eq filename
+        end
+      end
 
+      context "when there is one file with the exact name, and one that just ends with the name" do
         before do
-          scripts[1][:run] = false
-          scripts[2][:run] = false
-          klass.stub pending_scripts: [script_filenames[0], bad_filename, script_filenames[1], script_filenames[2]]
-          klass.run_pending_scripts
+          Dir.stub(:glob).with(path).and_return(["5123451234_prepare_#{name}.rb", "#{filename}.rb"])
         end
 
-        it_behaves_like "ran scripts"
+        it "is the one with the exact name" do
+          expect(subject).to eq filename
+        end
+      end
 
-        it "requires the path for the bad script" do
-          path = Rails.root.join("db", "config_scripts", "#{bad_filename}.rb")
-          expect(klass).to have_received(:require).with(path)
+      context "when there are no files with the name" do
+        before do
+          Dir.stub(:glob).with(path).and_return([])
         end
 
-        it "outputs a name error for the missing class" do
-          expect(klass).to have_received(:puts).with("Aborting: could not find class MissingClassConfig")
+        it "is nil" do
+          expect(subject).to be_nil
         end
       end
     end

data/spec/seeds/seed_type_spec.rb

@@ -185,6 +185,25 @@ describe ConfigScripts::Seeds::SeedType do
         end
       end
 
+      context "with exception" do
+        subject { seed_type.read_from_folder(folder) }
+
+        before do
+          $stdout.stub :puts
+          Person.any_instance.stub(:save!).and_raise
+          seed_type.has_attributes :name, :hair_color
+        end
+
+        it "is an exception" do
+          expect{ subject }.to raise_error
+        end
+
+        it "outputs the problem file name" do
+          expect($stdout).to receive(:puts).with('people.csv')
+          expect{ subject }.to raise_error
+        end
+      end
+
       context "with no attributes" do
         before do
           seed_type.read_from_folder(folder)

data/spec/spec_helper.rb

@@ -35,4 +35,5 @@ RSpec.configure do |config|
 
   config.filter_run focus: true
   config.run_all_when_everything_filtered = true
+  config.treat_symbols_as_metadata_keys_with_true_values = true
 end

metadata

@@ -1,153 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: config_scripts
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - John Brownlee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-15 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - '>'
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - '>'
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: generator_spec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Library for creating trackable config scripts, and reading and writing
@@ -158,9 +158,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".yardopts"
+- .gitignore
+- .rspec
+- .yardopts
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -180,7 +180,7 @@ files:
 - lib/config_scripts/seeds/seed_set.rb
 - lib/config_scripts/seeds/seed_type.rb
 - lib/config_scripts/tasks.rb
-- lib/config_scripts/tasks/pending_migrations.rake
+- lib/config_scripts/tasks/migrations.rake
 - lib/config_scripts/tasks/seeds.rake
 - lib/config_scripts/version.rb
 - spec/dummy/README.rdoc
@@ -230,6 +230,7 @@ files:
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
+- spec/dummy/tmp/cache/.gitkeep
 - spec/generators/config_script_spec.rb
 - spec/generators/migrations_spec.rb
 - spec/scripts/script_history_spec.rb
@@ -249,12 +250,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -311,6 +312,7 @@ test_files:
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
+- spec/dummy/tmp/cache/.gitkeep
 - spec/generators/config_script_spec.rb
 - spec/generators/migrations_spec.rb
 - spec/scripts/script_history_spec.rb

data/lib/config_scripts/tasks/pending_migrations.rake

@@ -1,11 +0,0 @@
-namespace :config_scripts do
-  desc "Run pending config scripts"
-  task :run_pending => :environment do
-    ConfigScripts::Scripts::Script.run_pending_scripts
-  end
-
-  desc "List pending config scripts"
-  task :list_pending => :environment do
-    ConfigScripts::Scripts::Script.list_pending_scripts
-  end
-end