succotash 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d606ad6b450acc894db065927c310650dfad740f
+  data.tar.gz: f978dac7f191b7623cf67d83745e5fbf105c1930
+SHA512:
+  metadata.gz: bd746f32677dcb4121cc9fd73d251a2097f183e68eb26cbe83a618cc176d78127530dd8811da352d692c7b58ea089e659bbbe3ee3ed7d7c18b20425089dc6f68
+  data.tar.gz: 5ccc4191837cf8452449197965f0b9328795be05b2088b9f26142e7c646510d0b095c74d52e6c6383f1c4d0446c1b07108dedfdaabf040422bc2ff3799a947ac

data/.editorconfig

@@ -0,0 +1,14 @@
+# top-most EditorConfig file
+root = true
+
+[*]
+# all files should end with a new line
+end_of_line = lf
+insert_final_newline = true
+
+# 2 space indentation
+indent_style = space
+indent_size = 2
+
+# trim trailing white spaces
+trim_trailing_whitespace = true

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 John Cleary
+
+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,116 @@
+# Succotash
+
+A simple seeding strategy for your project which helps maintain and separate **static** and **sample** data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'succotash'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install succotash
+
+
+### Automatic configuration
+```ruby
+$ rake succotash:install
+```
+
+### Manual configuration
+Create the following files
+
+**db/seeds/static.yml**
+```ruby
+# list file names that needs to be included in the order required
+# eg
+# :static_seed_files:
+#   - customer_types.rb
+#   - error_codes.rb
+
+:static_seed_files:
+```
+
+**db/seeds/sample.yml**
+```ruby
+# list file names that needs to be included in the order required
+# eg
+# :sample_seed_files:
+#   - user_seed.rb
+#   - test_file.rb
+
+:sample_seed_files:
+
+```
+
+
+## Problem
+- Inconsistent approach to seeding data on development, integration and staging causing confusion and a loss of productivity (for example when manually seeded data is lost after a drop+seed)
+- Different approaches may be required for different kinds of seed data (sample seed, look-up table seed)
+- No defined approach to migrating data when structure changes (even more important now that we are live)
+
+These problems cost time for developers as they build local versions of services and each time they move services into integration, staging, acceptance and production.
+
+## Definitions
+
+##### Static Data
+Data that is required by the system in order for the system to function correctly. We should assume that this is run against **production** after every release so it should be **idempotent**. It would typically contain lookup data, but it must not include sample users or example data.
+
+##### Sample Data
+Data that is required to demo the system or individual features. Typically this will be run after a db:reset (and after the seed). It should never be run against production and therefore does not have to be idempotent.
+
+##### Idempotent
+Doesn’t change anything if you run it more than once, or more formally: ‘denoting an element of a set which is unchanged in value when multiplied or otherwise operated on by itself.’)
+
+
+
+## Usage
+
+Both static and sample data.
+```bash
+$ rake db:seed
+```
+
+Static data only.
+```bash
+$ rake db:seed:static
+```
+
+Sample data only.
+```bash
+$ rake db:seed:sample
+```
+
+`test.rb` file in the `db/seeds/static` directory
+```bash
+$ rake db:seed:static:test
+```
+
+`test.rb` file in the `db/seeds/sample` directory
+```bash
+$ rake db:seed:sample:test
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CreatekIO/succotash.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "succotash"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/succotash/railtie.rb

@@ -0,0 +1,11 @@
+module Succotash
+  class Railtie < Rails::Railtie
+    railtie_name :succotash
+
+    rake_tasks do
+      load "tasks/seed.rake"
+      load "tasks/succotash.rake"
+    end
+  end
+end
+

data/lib/succotash/version.rb

@@ -0,0 +1,3 @@
+module Succotash
+  VERSION = File.read(File.join(__dir__, '../../VERSION')).strip
+end

data/lib/succotash.rb

@@ -0,0 +1,8 @@
+require "succotash/version"
+require "succotash/railtie"
+require "colorize"
+require "yaml"
+
+module Succotash
+  # Your code goes here...
+end

data/lib/tasks/seed.rake

@@ -0,0 +1,56 @@
+# clear default db:seed task as want disable this behavior in favour of the
+# db:static and db:sample tasks
+Rake::Task['db:seed'].clear
+
+namespace :db do
+  desc "Run db:seed:static and db:seed:sample"
+  task seed: %w{seed:static seed:sample} do
+    warn "[WARNING] `db/seed.rb` and it;s task `rake db:seed` have been disabled by the succotash gem. Please move seed data to db/static.rb or db/sample.rb".light_yellow if File.exist? Fine.join(Rails.root, 'db/seeds.rb')
+  end
+
+  namespace :seed do
+
+    def load_seed_namespace ns
+      # create top-level task (eg db:seed:static or db:seed:sample)
+      desc "Load #{ns} seed file"
+      task ns => :environment do
+        seed_list = YAML::load_file("#{Rails.root}/db/seeds/#{ns}.yml")["#{ns}_seed_files".to_sym] || []
+        seed_list.each do |file|
+          load_seed "#{Rails.root}/db/seeds/#{ns}/#{file}"
+        end
+      end
+
+      namespace ns do
+        FileList["#{Rails.root}/db/seeds/#{ns}/*.rb"].each do |seed_file|
+          task_name = File.basename(seed_file, '.rb')
+
+          desc "Load #{task_name} #{ns} seed file"
+          task task_name => :environment do
+            load_seed seed_file
+          end
+        end
+      end
+
+    end
+
+    def load_seed seed_file
+      return if Rails.env == 'production'
+      if File.exist?(seed_file)
+        ActiveRecord::Base.transaction do
+          begin
+            puts "*** Seeding #{seed_file} ***".green
+            load seed_file
+          rescue => exception
+            warn exception.message.red
+          end
+        end
+      else
+        puts "#{seed_file} does not exist. Run `rake seed_runner:install` to create this or follow the README for manual install".red
+        puts "#{File.basename(seed_file, '.rb')} skipped"
+      end
+    end
+
+    load_seed_namespace 'static'
+    load_seed_namespace 'sample'
+  end
+end

data/lib/tasks/succotash.rake

@@ -0,0 +1,26 @@
+namespace :succotash do
+  desc "Create 'db/seeds/static.rb' and 'db/seeds/sample.rb'"
+  task :install do
+    spec = Gem::Specification.find_by_name 'succotash'
+
+    puts "*** Creating seed dirs ***".green
+    system("mkdir -p #{Rails.root}/db/seeds/{static,sample}") unless Dir.exist?("#{Rails.root}/db/seeds")
+    system("mkdir -p #{Rails.root}/db/seeds/static") unless Dir.exist?("#{Rails.root}/db/seeds/static")
+    system("mkdir -p #{Rails.root}/db/seeds/sample") unless Dir.exist?("#{Rails.root}/db/seeds/sample")
+
+    unless File.exist?("#{Rails.root}/db/seeds/static.yml")
+      system("cp #{spec.gem_dir}/lib/templates/static.yml #{Rails.root}/db/seeds/")
+      puts "*** Settings up static.rb ***".green
+    else
+      puts "*** static.rb already exists ***".yellow
+    end
+
+    unless File.exist?("#{Rails.root}/db/seeds/sample.yml")
+      system("cp #{spec.gem_dir}/lib/templates/sample.yml #{Rails.root}/db/seeds/")
+      puts "*** Settings up sample.rb ***".green
+    else
+      puts "*** sample.rb already exists ***".yellow
+    end
+
+  end
+end

data/lib/templates/sample.yml

@@ -0,0 +1,8 @@
+# list file names that needs to be included in the order required
+# EG
+# :sample_seed_files:
+#   - test_file.rb
+#   - demo_seed.rb
+
+:sample_seed_files:
+

data/lib/templates/static.yml

@@ -0,0 +1,7 @@
+# list file names that needs to be included in the order required
+# EG
+# :static_seed_files:
+#   - test_file.rb
+#   - demo_seed.rb
+
+:static_seed_files:

data/succotash.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'succotash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "succotash"
+  spec.version       = Succotash::VERSION
+  spec.authors       = ["Hassan Khalid", "John Cleary"]
+  spec.email         = ["dev@createk.io"]
+
+  spec.summary       = "A simple seeding strategy for your project which helps maintain and separate static and demo data."
+  spec.description   = "A simple seeding strategy for your project which helps maintain and separate static and demo data."
+  spec.homepage      = "https://github.com/CreatekIO/succotash"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "version", "~> 1.0.0"
+  spec.add_dependency "colorize", "0.7.7"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: succotash
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Hassan Khalid
+- John Cleary
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+description: A simple seeding strategy for your project which helps maintain and separate
+  static and demo data.
+email:
+- dev@createk.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .editorconfig
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/console
+- bin/setup
+- lib/succotash.rb
+- lib/succotash/railtie.rb
+- lib/succotash/version.rb
+- lib/tasks/seed.rake
+- lib/tasks/succotash.rake
+- lib/templates/sample.yml
+- lib/templates/static.yml
+- succotash.gemspec
+homepage: https://github.com/CreatekIO/succotash
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A simple seeding strategy for your project which helps maintain and separate
+  static and demo data.
+test_files: []