seed_helper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7deef5a48d06c4551b328b949d99b0fc5a8517be
+  data.tar.gz: 5e3f65dd5a77ebbcef723ac4a8b0b6edcfcb7217
+SHA512:
+  metadata.gz: 8db99b64e111739b3d187885e9409ab55a62cc363a98772032e694537559da4d589dd8613cc12cb281a4ab2b525883c8d4f3d0a041aa9a89f1b22ab23c0ac093
+  data.tar.gz: c94008a4757b8f224f74f4af19b3bf7c3193abfc9b525fdd4dc551721d86c6065344a17f44692fcecf846db50c229d0800a791658f6a1d6c699a0ce79139e099

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--debug

data/.ruby-gemset

@@ -0,0 +1 @@
+seed_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/DEVELOPER_README.md

@@ -0,0 +1,23 @@
+# SeedHelper
+
+This is a README for working on SeedHelper
+
+## Installing
+
+```
+gem build seed_helper.gemspec
+gem install ./seed_helper-2.0.0.gem
+```
+
+## Running
+
+Get into `irb`.
+
+Run 
+
+```
+require 'seed_helper'
+include SeedHelper
+```
+
+Now you can use the functions in seed_helper.rb

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in seed_helper.gemspec
+gemspec
+gem 'rspec'
+gem 'ruby-debug'

data/README.md

@@ -0,0 +1,64 @@
+# SeedHelper
+
+SeedHelper is a small gem I created while I was working on various projects with terrible Seed files.
+
+## Purpose
+
+The goal of SeedHelper is to provide some commonly required functionality to make creating Seed files easier.
+
+## Dependencies
+
+SeedHelper uses the [colored](https://github.com/defunkt/colored) gem to present output.
+
+## Example: Seed implementation
+
+I use rake tasks to create my seed data. That way you can easily run individual tasks for seeding specific pieces of data.
+
+Using SeedHelper, a seed task might look like:
+
+```ruby
+# in lib/tasks/seeds/create_roles.rake
+
+create_seed_task(:create_roles) do
+  
+  ["Admin", "Regular"].each do |role_name|
+
+    # Will print out a red message if Role fails to save
+    # Will print out a green message is Role succesfully creates
+    # Will print out a cyan message if Role already exists
+    role = create_resource(Role, {name: role_name})
+
+  end
+
+end
+
+# in lib/tasks/seeds/create_users.rake
+
+# Specify a dependency on roles, so that running this task will first
+# run the create_roles task
+create_seed_task(:create_users, [:create_roles]) do
+  
+  [
+    ["admin@example.com", "Admin"]
+  ].each do |email, role_name|
+
+    role = Role.find_by(name: role_name)
+    admin = create_resource(User, {email: email})
+
+  end
+
+end
+```
+
+Keep in mind that the create_resource requires at least Rails 4.0.2 to run as it uses the `find_by` method.
+
+## Example: Output
+
+SeedHelper provides multiple methods for showing output that can be used outside of the `create_resource` method:
+
+- `message` A general purpose message, generally used as a header. White by default.
+- `success` Indicates a seed function was successful. Green by default.
+- `error` Indicates a seed function has failed. Red by default.
+- `resource_already_exists` Indicates that the data already exists in the database.
+- `special_message` Show a purple multiline message. I use this to show logins for seed users.
+- `print_new_line` Just to add a single space to separate groups of functionality.

data/Rakefile

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

data/lib/seed_helper.rb

@@ -0,0 +1,26 @@
+require 'colored'
+require 'seed_helper/version'
+require 'seed_helper/output_formatter'
+require 'seed_helper/rake_helper'
+
+module SeedHelper
+  include SeedHelper::OutputFormatter
+  include SeedHelper::RakeHelper 
+
+  def create_resource(resource_class, attributes)
+    if resource = resource_class.find_by(attributes)
+      resource_already_exists(resource)
+    else
+      resource = resource_class.new(attributes)
+      if resource.save
+        message = "#{resource} successfully created"
+        success(message)
+      else
+        message = "#{resource} failed to create. Errors: #{resource.errors.full_messages}"
+        error(message)
+      end
+    end
+    return resource
+  end
+
+end

data/lib/seed_helper/output_formatter.rb

@@ -0,0 +1,55 @@
+module SeedHelper::OutputFormatter
+
+  # Outputs a message with a set of given options
+  #
+  # @param [String] message: The message to format
+  # @param [Hash] options: A hash of options to apply to the string
+  # @option options [String] prefix: A prefix for the message. EG: "--> message"
+  # @option options [String] color: A Symbol representing the color from the Colored gem. See: Colored.colors
+  # @option options [String] suffix: A String suffix for the message. EG: "message !!!"
+  #
+  # @example Print out an error message
+  #   SeedHelper.output "Some error", {:prefix => "!!! ", :color => :red}
+  #   # outputs "!!! Some error" in red text
+  def output(message, options = {})
+    options[:color] ||= :white
+    $stdout.puts "#{options[:prefix]}#{message}#{options[:suffix]}".send(options[:color])
+  end
+
+  def message(message, options = {})
+    options[:prefix] ||= "*** "
+    options[:color] ||= :white
+    output message, options
+  end
+
+  def success(message, options = {})
+    options[:prefix] ||= "  + "
+    options[:color] ||= :green
+    output message, options
+  end
+
+  def error(message, options = {})
+    options[:prefix] ||= "  - "
+    options[:color] ||= :red
+    output message, options
+  end
+
+  def resource_already_exists(resource)
+    message = "#{resource} already exists"
+
+    options = {}
+    options[:prefix] ||= "  > "
+    options[:color]  ||= :cyan
+    output(message, options)
+  end
+
+  def special_message(*lines)
+    $stdout.puts ""
+    $stdout.puts lines.join("\n  ").magenta
+  end
+
+  def print_new_line
+    $stdout.puts ""
+  end
+
+end

data/lib/seed_helper/rake_helper.rb

@@ -0,0 +1,19 @@
+module SeedHelper::RakeHelper
+
+  def self.create_seed_task(task_name, dependencies=[], &task)
+    namespace :db do
+      namespace :seed do
+        desc "Creating #{task_name.to_s.humanize}"
+        task task_name => dependencies.append(:environment) do
+          message task_name.to_s.humanize
+
+          task.call
+
+          # Print a new line between each set of output for clarity
+          puts ""
+        end
+      end
+    end
+  end
+
+end

data/lib/seed_helper/version.rb

@@ -0,0 +1,3 @@
+module SeedHelper
+  VERSION = "1.0.0"
+end

data/license.txt

@@ -0,0 +1,13 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

data/seed_helper.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "seed_helper/version"
+
+Gem::Specification.new do |s|
+  s.name        = "seed_helper"
+  s.version     = SeedHelper::VERSION
+  s.authors     = ["Jordan Maguire"]
+  s.email       = ["jordan@thefrontiergroup.com.au"]
+  s.homepage    = "https://github.com/jordanmaguire/seed_helper"
+  s.summary     = "Make seeding data easier in Rails projects"
+  s.description = "Make seeding data easier in Rails projects"
+  s.licenses    = ['WTFPL']
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'colored'
+end

data/spec/lib/seed_formatter_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+
+class TestClass
+  include SeedHelper
+end
+
+describe SeedHelper do
+
+  let(:tc) { TestClass.new }
+
+  describe '#output' do
+    subject { tc.output message, options }
+    let(:message) { "message" }
+    let(:options) { {} }
+
+    context 'options[:prefix] is provided' do
+      let(:options) { {:prefix => "a prefix "} }
+      it "prefixes the message with options[:prefix]" do
+        $stdout.should_receive(:puts).with(/a prefix message/)
+        subject
+      end
+    end
+    context 'options[:suffix] is provided' do
+      let(:options) { {:suffix => " a suffix"} }
+      it "suffixes the message with options[:suffix]" do
+        $stdout.should_receive(:puts).with(/message a suffix/)
+        subject
+      end
+    end
+    context 'options[:color] is provided' do
+      let(:options) { {:color => :blue} }
+      it "prints the message with the provided color" do
+        $stdout.should_receive(:puts).with("\e[34mmessage\e[0m")
+        subject
+      end
+    end
+    context 'options[:color] is not provided' do
+      let(:options) { {:color => nil} }
+      it "prints the message in white by default" do
+        $stdout.should_receive(:puts).with("\e[37mmessage\e[0m")
+        subject
+      end
+    end
+  end
+
+  describe '#message' do
+    subject { tc.message message, options }
+    let(:message) { "message" }
+    let(:options) { {:prefix => prefix, :color => color} }
+    let(:prefix)  { nil }
+    let(:color)   { nil }
+    context 'options[:prefix] is provided' do
+      let(:prefix) { "a prefix " }
+      it 'passes options[:prefix] to output' do
+        tc.should_receive(:output).with(anything, hash_including(:prefix => prefix))
+        subject
+      end
+    end
+    context 'options[:prefix] is not provided' do
+      it 'passes a default prefix through to output' do
+        tc.should_receive(:output).with(anything, hash_including(:prefix => "*** "))
+        subject
+      end
+    end
+    context 'options[:color] is provided' do
+      let(:color) { :blue }
+      it 'passes options[:color] to output' do
+        tc.should_receive(:output).with(anything, hash_including(:color => color))
+        subject
+      end
+    end
+    context 'options[:color] is not provided' do
+      it 'passes a default color through to output' do
+        tc.should_receive(:output).with(anything, hash_including(:color => :white))
+        subject
+      end
+    end
+  end
+
+  describe '#success' do
+    subject { tc.success message, options }
+    let(:message) { "message" }
+    let(:options) { {:prefix => prefix, :color => color} }
+    let(:prefix)  { nil }
+    let(:color)   { nil }
+    context 'options[:prefix] is provided' do
+      let(:prefix) { "a prefix " }
+      it 'passes options[:prefix] to output' do
+        tc.should_receive(:output).with(anything, hash_including(:prefix => prefix))
+        subject
+      end
+    end
+    context 'options[:prefix] is not provided' do
+      it 'passes a default prefix through to output' do
+        tc.should_receive(:output).with(anything, hash_including(:prefix => "  + "))
+        subject
+      end
+    end
+    context 'options[:color] is provided' do
+      let(:color) { :blue }
+      it 'passes options[:color] to output' do
+        tc.should_receive(:output).with(anything, hash_including(:color => color))
+        subject
+      end
+    end
+    context 'options[:color] is not provided' do
+      it 'passes a default color through to output' do
+        tc.should_receive(:output).with(anything, hash_including(:color => :green))
+        subject
+      end
+    end
+  end
+
+  describe '#error' do
+    subject { tc.error message, options }
+    let(:message) { "message" }
+    let(:options) { {:prefix => prefix, :color => color} }
+    let(:prefix)  { nil }
+    let(:color)   { nil }
+    context 'options[:prefix] is provided' do
+      let(:prefix) { "a prefix " }
+      it 'passes options[:prefix] to output' do
+        tc.should_receive(:output).with(anything, hash_including(:prefix => prefix))
+        subject
+      end
+    end
+    context 'options[:prefix] is not provided' do
+      it 'passes a default prefix through to output' do
+        tc.should_receive(:output).with(anything, hash_including(:prefix => "  - "))
+        subject
+      end
+    end
+    context 'options[:color] is provided' do
+      let(:color) { :blue }
+      it 'passes options[:color] to output' do
+        tc.should_receive(:output).with(anything, hash_including(:color => color))
+        subject
+      end
+    end
+    context 'options[:color] is not provided' do
+      it 'passes a default color through to output' do
+        tc.should_receive(:output).with(anything, hash_including(:color => :red))
+        subject
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'seed_helper'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: seed_helper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jordan Maguire
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make seeding data easier in Rails projects
+email:
+- jordan@thefrontiergroup.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- DEVELOPER_README.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/seed_helper.rb
+- lib/seed_helper/output_formatter.rb
+- lib/seed_helper/rake_helper.rb
+- lib/seed_helper/version.rb
+- license.txt
+- seed_helper.gemspec
+- spec/lib/seed_formatter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jordanmaguire/seed_helper
+licenses:
+- WTFPL
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Make seeding data easier in Rails projects
+test_files:
+- spec/lib/seed_formatter_spec.rb
+- spec/spec_helper.rb