RubyGems - config_scripts - Versions diffs - 0.4.1 - Mend

config_scripts 0.4.1

Files changed (83) hide show

checksums.yaml +7 -0
data/.gitignore +16 -0
data/.rspec +2 -0
data/.yardopts +1 -0
data/CHANGELOG.md +17 -0
data/Gemfile +4 -0
data/Gemfile.lock +124 -0
data/LICENSE.txt +22 -0
data/README.md +55 -0
data/Rakefile +1 -0
data/TODO.md +8 -0
data/config_scripts.gemspec +31 -0
data/lib/config_scripts/generators/config_script.rb +24 -0
data/lib/config_scripts/generators/migrations.rb +36 -0
data/lib/config_scripts/generators.rb +2 -0
data/lib/config_scripts/scripts/script.rb +135 -0
data/lib/config_scripts/scripts/script_history.rb +39 -0
data/lib/config_scripts/scripts.rb +9 -0
data/lib/config_scripts/seeds/seed_set.rb +321 -0
data/lib/config_scripts/seeds/seed_type.rb +361 -0
data/lib/config_scripts/seeds.rb +8 -0
data/lib/config_scripts/tasks/pending_migrations.rake +11 -0
data/lib/config_scripts/tasks/seeds.rake +18 -0
data/lib/config_scripts/tasks.rb +12 -0
data/lib/config_scripts/version.rb +4 -0
data/lib/config_scripts.rb +9 -0
data/spec/dummy/README.rdoc +28 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/app/assets/images/.keep +0 -0
data/spec/dummy/app/assets/javascripts/application.js +13 -0
data/spec/dummy/app/assets/stylesheets/application.css +13 -0
data/spec/dummy/app/controllers/application_controller.rb +5 -0
data/spec/dummy/app/controllers/concerns/.keep +0 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/mailers/.keep +0 -0
data/spec/dummy/app/models/.keep +0 -0
data/spec/dummy/app/models/concerns/.keep +0 -0
data/spec/dummy/app/models/hair_color.rb +2 -0
data/spec/dummy/app/models/person.rb +4 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/config/application.rb +23 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +29 -0
data/spec/dummy/config/environments/production.rb +80 -0
data/spec/dummy/config/environments/test.rb +36 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +12 -0
data/spec/dummy/config/initializers/session_store.rb +3 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +23 -0
data/spec/dummy/config/routes.rb +56 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/db/migrate/20140208014550_create_config_scripts.rb +7 -0
data/spec/dummy/db/migrate/20140208161829_create_people.rb +9 -0
data/spec/dummy/db/migrate/20140208182050_create_hair_colors.rb +9 -0
data/spec/dummy/db/migrate/20140208182101_add_hair_color_to_person.rb +6 -0
data/spec/dummy/db/migrate/20140208225801_add_scope_to_people.rb +6 -0
data/spec/dummy/db/migrate/20140209132911_add_hex_value_to_hair_color.rb +5 -0
data/spec/dummy/db/schema.rb +38 -0
data/spec/dummy/lib/assets/.keep +0 -0
data/spec/dummy/log/.keep +0 -0
data/spec/dummy/public/404.html +58 -0
data/spec/dummy/public/422.html +58 -0
data/spec/dummy/public/500.html +57 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/generators/config_script_spec.rb +23 -0
data/spec/generators/migrations_spec.rb +23 -0
data/spec/scripts/script_history_spec.rb +53 -0
data/spec/scripts/script_spec.rb +282 -0
data/spec/seeds/seed_set_spec.rb +371 -0
data/spec/seeds/seed_type_spec.rb +439 -0
data/spec/spec_helper.rb +38 -0
data/templates/config_script.rb +9 -0
data/templates/create_config_scripts_migration.rb +7 -0
metadata +321 -0

data/spec/dummy/public/404.html ADDED Viewed

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+  }
+  div.dialog {
+    width: 25em;
+    margin: 4em auto 0 auto;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 4em 0 4em;
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  body > p {
+    width: 33em;
+    margin: 0 auto 1em;
+    padding: 1em 0;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED Viewed

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+  }
+  div.dialog {
+    width: 25em;
+    margin: 4em auto 0 auto;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 4em 0 4em;
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  body > p {
+    width: 33em;
+    margin: 0 auto 1em;
+    padding: 1em 0;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,57 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+  }
+  div.dialog {
+    width: 25em;
+    margin: 4em auto 0 auto;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 4em 0 4em;
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  body > p {
+    width: 33em;
+    margin: 0 auto 1em;
+    padding: 1em 0;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/spec/dummy/public/favicon.ico ADDED Viewed

File without changes

data/spec/generators/config_script_spec.rb ADDED Viewed

@@ -0,0 +1,23 @@
+require 'generator_spec'
+describe ConfigScripts::ConfigScriptGenerator, type: :generator do
+  destination File.expand_path("../../../tmp", __FILE__)
+  arguments ['TestConfigScript']
+  describe "config_script" do
+    let(:expected_path) { "db/config_scripts/#{Time.now.to_s(:number)}_test_config_script.rb" }
+    before do
+      prepare_destination
+      Timecop.freeze
+      run_generator
+    end
+    after do
+      Timecop.return
+    end
+    it "creates a file in the config_scripts directory, with a config script class" do
+      assert_file expected_path, /class TestConfigScriptConfig < ConfigScripts::Scripts::Script/
+    end
+  end
+end

data/spec/generators/migrations_spec.rb ADDED Viewed

@@ -0,0 +1,23 @@
+describe ConfigScripts::MigrationsGenerator, type: :generator do
+  destination File.expand_path("../../../tmp", __FILE__)
+  describe "create_migrations" do
+    before do
+      prepare_destination
+      run_generator
+    end
+    it "creates a migration for adding the config scripts table" do
+      assert_file "db/migrate/#{Time.now.to_s(:number)}_create_config_scripts.rb", /create_table :config_scripts/
+    end
+    context "when running repeatedly" do
+      it "says that it has skipped it" do
+        output = capture :stderr do
+          run_generator
+        end
+        expect(output).to be =~ /Another migration is already named create_config_scripts/
+      end
+    end
+  end
+end

data/spec/scripts/script_history_spec.rb ADDED Viewed

@@ -0,0 +1,53 @@
+describe ConfigScripts::Scripts::ScriptHistory do
+  let(:klass) { ConfigScripts::Scripts::ScriptHistory }
+  let(:timestamp1) { 5.minutes.ago.to_s(:number) }
+  let(:timestamp2) { 10.minutes.ago.to_s(:number) }
+  describe "entries_for_timestamp" do
+    let!(:entry1) { klass.create(name: timestamp1) }
+    let!(:entry2) { klass.create(name: timestamp1) }
+    let!(:entry3) { klass.create(name: timestamp2) }
+    subject { klass.entries_for_timestamp(timestamp1) }
+    it "gets all the entries whose timestamp has the value given" do
+      expect(subject).to include entry1
+      expect(subject).to include entry2
+    end
+    it "does not include entries with other timestamps" do
+      expect(subject).not_to include entry3
+    end
+  end
+  describe "script_was_run?" do
+    let!(:entry1) { klass.create(name: timestamp2) }
+    context "with a timestamp that has an entry in the table" do
+      subject { klass.script_was_run?(timestamp2) }
+      it { should be_true }
+    end
+    context "with a timestamp that has no entry in the table" do
+      subject { klass.script_was_run?(timestamp1) }
+      it { should be_false }
+    end
+  end
+  describe "record_timestamp" do
+    it "adds an entry to the table" do
+      expect(klass.script_was_run?(timestamp1)).to be_false
+      klass.record_timestamp(timestamp1)
+      expect(klass.script_was_run?(timestamp1)).to be_true
+    end
+  end
+  describe "remove_timestamp" do
+    it "removes the entry from the table" do
+      klass.create(name: timestamp2)
+      expect(klass.script_was_run?(timestamp2)).to be_true
+      klass.remove_timestamp(timestamp2)
+      expect(klass.script_was_run?(timestamp2)).to be_false
+    end
+  end
+end

data/spec/scripts/script_spec.rb ADDED Viewed

@@ -0,0 +1,282 @@
+describe ConfigScripts::Scripts::Script do
+  let(:klass) { ConfigScripts::Scripts::Script }
+  describe "class methods" do
+    describe "script_directory" do
+      subject { klass.script_directory}
+      it "is the db/config_scripts directory" do
+        expect(subject).to eq Rails.root.join('db', 'config_scripts')
+      end
+    end
+    describe "pending_scripts" do
+      let!(:filename1) { "20140208150000_script_1" }
+      let!(:filename2) { "20140208200000_script_2" }
+      subject { klass.pending_scripts }
+      before do
+        Dir.stub glob: ["/tmp/#{filename1}.rb", "/tmp/#{filename2}.rb"]
+        ConfigScripts::Scripts::ScriptHistory.record_timestamp('20140208150000')
+      end
+      it "uses Dir to get the files" do
+        subject
+        expect(Dir).to have_received(:glob).with(File.join(klass.script_directory, "*.rb"))
+      end
+      it "includes filenames that don't have entries in the script histories" do
+        expect(subject).to include filename2
+      end
+      it "does not include filenames that have entries in the script history" do
+        expect(subject).not_to include filename1
+      end
+    end
+    describe "run_pending_scripts" do
+      class TestConfigScriptConfig < ConfigScripts::Scripts::Script; end
+      let!(:timestamp1) { '20140208150000' }
+      let!(:timestamp2) { '20140208200000' }
+      let!(:timestamp3) { '20140208250000' }
+      let(:script_filenames) { [timestamp1, timestamp2, timestamp3].collect { |stamp| "#{stamp}_test_config_script" } }
+      let!(:script1) { TestConfigScriptConfig.new(timestamp1) }
+      let!(:script2) { TestConfigScriptConfig.new(timestamp2) }
+      let!(:script3) { TestConfigScriptConfig.new(timestamp3) }
+      before do
+        klass.stub pending_scripts: script_filenames
+        klass.stub :require
+        klass.stub :puts
+        [script1, script2, script3].each do |script|
+          script.stub(:run)
+        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)
+        FileUtils.mkdir_p(Rails.root.join("tmp", "cache"))
+      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
+        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
+        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
+        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
+        end
+      end
+      context "with no problems running the scripts" do
+        it_behaves_like "ran scripts"
+        before do
+          klass.run_pending_scripts
+        end
+      end
+      context "with a problems running the scripts" do
+        it_behaves_like "ran scripts"
+        before do
+          script2.stub(:run).and_raise 'Error in script'
+          scripts[2][:run] = false
+          begin
+            klass.run_pending_scripts
+          rescue
+          end
+        end
+      end
+      context "with a class name it cannot find" do
+        let(:bad_filename) { "20140208170000_missing_class" }
+        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
+        end
+        it_behaves_like "ran scripts"
+        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)
+        end
+        it "outputs a name error for the missing class" do
+          expect(klass).to have_received(:puts).with("Aborting: could not find class MissingClassConfig")
+        end
+      end
+    end
+    describe "list_pending_scripts" do
+      before do
+        klass.stub pending_scripts: ['script1.rb', 'script2.rb']
+        klass.stub :puts
+        klass.list_pending_scripts
+      end
+      it "prints out the name of each script" do
+        expect(klass).to have_received(:puts).with('script1.rb')
+        expect(klass).to have_received(:puts).with('script2.rb')
+      end
+    end
+  end
+  describe "creating" do
+    let(:timestamp) { '20140101153500' }
+    subject { klass.new(timestamp) }
+    it "sets the timestamp" do
+      expect(subject.timestamp).to eq timestamp
+    end
+  end
+  describe "running" do
+    let(:timestamp) { 1.day.ago.to_s(:number)}
+    let(:script) { ConfigScripts::Scripts::Script.new(timestamp) }
+    describe "up" do
+      it "raises an exception" do
+        expect(lambda{script.up}).to raise_exception("Not supported")
+      end
+    end
+    describe "down" do
+      it "raises an exception" do
+        expect(lambda{script.down}).to raise_exception("Not supported")
+      end
+    end
+    describe "run" do
+      {up: true, down: false}.each do |direction, expect_timestamp|
+        describe "direction" do
+          before do
+            if !expect_timestamp
+              ConfigScripts::Scripts::ScriptHistory.record_timestamp(timestamp)
+            end
+            script.stub :puts
+            Rails.cache.write("cached_item", "cached_value")
+          end
+          context "with a success" do
+            before do
+              script.stub(direction) do
+                Person.create(name: 'John Doe')
+              end
+              script.run(direction)
+            end
+            it "performs the changes in the #{direction} method" do
+              expect(Person.count).to eq 1
+              expect(Person.first.name).to eq "John Doe"
+            end
+            it "cleares the cache" do
+              expect(Rails.cache.read("cached_item")).to be_nil
+            end
+            it "{expect_timestamp ? 'adds' : 'removes'} the timestamp" do
+              expect(ConfigScripts::Scripts::ScriptHistory.script_was_run?(timestamp)).to eq expect_timestamp
+            end
+          end
+          context "with an exception in the #{direction} method" do
+            before do
+              script.stub(direction) do
+                Person.create(name: 'John Doe')
+                raise
+              end
+            end
+            it "re-raises the exception" do
+              expect(lambda{script.run(direction)}).to raise_exception
+            end
+            it "does not persist the changes in the #{direction} method" do
+              script.run(direction) rescue nil
+              expect(Person.count).to eq 0
+            end
+            it "does not clear the cache" do
+              script.run(direction) rescue nil
+              expect(Rails.cache.read('cached_item')).to eq 'cached_value'
+            end
+            it "does not #{expect_timestamp ? 'add' : 'remove'} the timestamp" do
+              script.run(direction) rescue nil
+              expect(ConfigScripts::Scripts::ScriptHistory.script_was_run?(timestamp)).not_to eq expect_timestamp
+            end
+            it "puts an error out to the logs" do
+              script.run(direction) rescue nil
+              expect(script).to have_received(:puts).with("Error running script for ConfigScripts::Scripts::Script: ")
+            end
+          end
+        end
+      end
+    end
+  end
+end