config_scripts 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f9ab8bf09440a9182b9450651756d9cdde28109
+  data.tar.gz: ab9ff7ebde2313fee3071c9dcff710219cc1d3bf
+SHA512:
+  metadata.gz: c51d874865f2080a14ee8a13576b828fbdf8dd5935e32b1311384b276a16816b3d18283da8fb97c0dda8b0bf81f9dd5dc9ae136fa67dd97aaa4341dc2f4516e9
+  data.tar.gz: 13a589c68a9ce1d9a9b44aa00bf8593aade3c1d10e3bc72051226a65ad69e1d08015901c33f47efffc522548210c4973650b149b2b9a5624709e97cba6aa103f

data/.gitignore

@@ -0,0 +1,16 @@
+# YARD Documentation 
+.yardoc
+doc/code
+
+# Simplecov Code Coverage
+doc/coverage
+
+# Files from Dummy App for Specs
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+
+# tmp files creating from specs
+tmp/
+
+# Package gem files
+pkg/

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.yardopts

@@ -0,0 +1 @@
+-o doc/code

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Version 0.4.0 - 9 February 2014
+
+* Adds support for polymorphic foreign keys
+* Adds support for custom readers and writers for attribute values.
+* Adds the ability to read and write individual seed sets.
+
+# Version 0.3.0 - 8 February 2014
+
+* Adds the last of the specs.
+
+# Version 0.2.0 - 3 February 2014
+
+* Adds documentation
+
+# Version 0.1.0 - 2 February 2014
+
+* Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in config_scripts.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,124 @@
+PATH
+  remote: .
+  specs:
+    config_scripts (0.4.1)
+      rails (> 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.2)
+      actionpack (= 4.0.2)
+      mail (~> 2.5.4)
+    actionpack (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.2)
+      activesupport (= 4.0.2)
+      builder (~> 3.1.0)
+    activerecord (4.0.2)
+      activemodel (= 4.0.2)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.2)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.2)
+    atomic (1.1.14)
+    builder (3.1.4)
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    erubis (2.7.0)
+    generator_spec (0.9.2)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    hike (1.2.3)
+    i18n (0.6.9)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    minitest (4.7.5)
+    multi_json (1.8.4)
+    polyglot (0.3.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.2)
+      actionmailer (= 4.0.2)
+      actionpack (= 4.0.2)
+      activerecord (= 4.0.2)
+      activesupport (= 4.0.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.2)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.2)
+      actionpack (= 4.0.2)
+      activesupport (= 4.0.2)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.5)
+    rspec-rails (2.14.1)
+      actionpack (>= 3.0)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    sprockets (2.10.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.8)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tilt (1.4.1)
+    timecop (0.7.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.38)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  config_scripts!
+  generator_spec
+  rake
+  rspec
+  rspec-rails
+  simplecov
+  sqlite3
+  timecop
+  yard

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 John Brownlee
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# ConfigScripts
+
+This gem provides libraries for generating configuration scripts, and reading
+and writing seed data to spreadsheets.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'config_scripts'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install config_scripts
+
+Generate the new migrations for the config_scripts table:
+
+    $ rails g config_scripts:migrations
+
+And run them:
+
+    $ rake db:migrate
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TODO.md

@@ -0,0 +1,8 @@
+### Features
+
+* Rolling back scripts
+* Generators for seed directories
+
+### Gem Preparation
+
+* Add examples to the Readme

data/config_scripts.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'config_scripts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "config_scripts"
+  spec.version       = ConfigScripts::VERSION
+  spec.authors       = ["John Brownlee"]
+  spec.email         = ["apps@johnbrownlee.com"]
+  spec.description   =  "Library for creating trackable config scripts, and reading and writing seed data into spreadsheets"
+  spec.summary       = "Config scripts and seed files for Rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", "> 3.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'generator_spec'
+  spec.add_development_dependency 'rspec-rails'
+end

data/lib/config_scripts/generators/config_script.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+module ConfigScripts
+  # This class provides a generator for creating a config new script.
+  class ConfigScriptGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../../../../templates', __FILE__)
+
+    # This method creates a new config script.
+    #
+    # It will take a template file from +templates/config_scripts+, and the
+    # name passed in when runing the generator, and create a file under
+    # +db/config_scripts+ in the app.
+    #
+    # The config script filename will be prefixed with a timestamp, like a
+    # database migration. The class defined in the config script will have
+    # the name passed in to the generator.
+    #
+    # @return [Nil]
+    def config_script
+      path = "db/config_scripts/#{Time.now.to_s(:number)}_#{self.file_name}.rb"
+      template "config_script.rb", path, {name: name}
+      nil
+    end
+  end
+end

data/lib/config_scripts/generators/migrations.rb

@@ -0,0 +1,36 @@
+require 'rails/generators'
+module ConfigScripts
+  # This class provides a generator for creating the migrations that we need to
+  # use this gem.
+  class MigrationsGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../../../../templates', __FILE__)
+
+    # This generator creates the migrations that we need for the gem.
+    def create_migrations
+      copy_migration 'create_config_scripts'
+    end
+
+    # This method gets the number for the next migration created by this
+    # generator.
+    #
+    # @param [String] dirname
+    #   The name of the directory in which we are creating the migrations.
+    #
+    # We use the current timestamp.
+    def self.next_migration_number(dirname)
+      Time.now.to_s(:number)
+    end
+
+    protected
+
+    # This method copies a migration from our template directory to the app's
+    # migrations directory.
+    #
+    # @param [String] filename
+    #   The name of the file in the templates directory.
+    def copy_migration(filename)
+      migration_template "#{filename}_migration.rb", "db/migrate/#{filename}.rb"
+    end
+  end
+end

data/lib/config_scripts/generators.rb

@@ -0,0 +1,2 @@
+require 'config_scripts/generators/migrations'
+require 'config_scripts/generators/config_script'

data/lib/config_scripts/scripts/script.rb

@@ -0,0 +1,135 @@
+module ConfigScripts
+  module Scripts
+    # This class is the base class for all of the config scripts that the
+    # app will define.
+    class Script
+      # @!group Config
+
+      # This method gets the directory in which the scripts will be stored.
+      #
+      # The scripts are stored in the +db/config_scripts+ directory under the app.
+      #
+      # @return [String]
+      def self.script_directory
+        Rails.root.join('db', 'config_scripts')
+      end
+
+      # @!group Pending Scripts
+
+      # This method gets the scripts that we have not yet run.
+      #
+      # We will return the filenames, without the extensions.
+      #
+      # @return [Array<String>]
+      def self.pending_scripts
+        paths = Dir.glob(File.join(self.script_directory, '*.rb'))
+        paths.collect do |path|
+          filename = File.basename(path, ".rb")
+          timestamp = filename[0, 14]
+          ScriptHistory.script_was_run?(timestamp) ? nil : filename
+        end.compact
+      end
+
+      # This method runs all the scripts that have not yet been run.
+      #
+      # @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)
+        end
+        true
+      end
+
+      # This method prints out the names of all of the scripts that have not
+      # been run.
+      def self.list_pending_scripts
+        self.pending_scripts.each do |filename|
+          puts filename
+        end
+      end
+
+      # @!group Creating
+
+      # This method creates a new script.
+      #
+      # @param [String] timestamp
+      #   The timestamp that is used to uniquely indentify the script.
+      #
+      # @return [Script]
+      def initialize(timestamp)
+        @timestamp = timestamp
+      end
+
+      # @!group Running
+
+      # @return [String]
+      # The timestamp for this instance of the script.
+      attr_accessor :timestamp
+
+      # This method performs the changes for this config script.
+      #
+      # This implementation raises an exception. Subclasses must define this
+      # method.
+      #
+      # If there are any issues running the script, this method should raise an
+      # exception.
+      def up
+        raise "Not supported"
+      end
+
+      # This method rolls back the changes for this config script.
+      #
+      # This implementation raises an exception. Subclasses must define this
+      # method if their scripts can be rolled back.
+      #
+      # If there are any issues rolling back the script, this method should
+      # raise an exception.
+      def down
+        raise "Not supported"
+      end
+
+      # This method runs the script in a given direction.
+      #
+      # This will use either the +up+ or +down+ method. That method call will be
+      # wrapped in a transaction, so if the script raises an exception, all of
+      # its changes will be rolled back.
+      #
+      # If the method runs successfully, this will either record a timestamp
+      # or remove a timestamp in the +config_scripts+ table.
+      #
+      # @param [Symbol] direction
+      #   Whether we should run +up+ or +down+.
+      def run(direction)
+        ActiveRecord::Base.transaction do
+          begin
+            self.send(direction)
+          rescue => e
+            puts "Error running script for #{self.class.name}: #{e.message}"
+            puts e.backtrace.first
+            raise e
+          end
+
+          case(direction)
+          when :up
+            ScriptHistory.record_timestamp(@timestamp)
+          when :down
+            ScriptHistory.remove_timestamp(@timestamp)
+          end
+          Rails.cache.clear
+        end
+      end
+    end
+  end
+end

data/lib/config_scripts/scripts/script_history.rb

@@ -0,0 +1,39 @@
+module ConfigScripts
+  module Scripts
+    # This class models a record of a script being run.
+    #
+    # This uses the +config_scripts+ table to record its histories.
+    class ScriptHistory < ActiveRecord::Base
+      self.table_name = 'config_scripts'
+
+      # @!attribute name
+      # The name of the script, which will be its timestamp.
+      # @return [String]
+
+      # This method gets all of the entries that have a timestamp as their name.
+      # @return [Relation<ScriptHistory>]
+      def self.entries_for_timestamp(timestamp)
+        self.where(:name => timestamp)
+      end
+
+      # This method determines if we have run a script with a timestamp.
+      # @return [Boolean]
+      def self.script_was_run?(timestamp)
+        self.entries_for_timestamp(timestamp).any?
+      end
+
+      # This method records that we have run a script with a timestamp.
+      # @return [ScriptHistory]
+      def self.record_timestamp(timestamp)
+        self.entries_for_timestamp(timestamp).first_or_create
+      end
+
+      # This method removes all records that we have run a script with a
+      # timestamp.
+      # @return [Array<ScriptHistory>]
+      def self.remove_timestamp(timestamp)
+        self.entries_for_timestamp(timestamp).destroy_all
+      end
+    end
+  end
+end

data/lib/config_scripts/scripts.rb

@@ -0,0 +1,9 @@
+module ConfigScripts
+  # This module encapsulates code for generating and running configuration
+  # scripts.
+  module Scripts
+  end
+end
+
+require 'config_scripts/scripts/script'
+require 'config_scripts/scripts/script_history'