seed_formatter 0.0.2 → 0.0.3

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use tfg@seed_formatter --create

data/Gemfile

@@ -2,3 +2,5 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in seed_formatter.gemspec
 gemspec
+gem 'rspec'
+gem 'ruby-debug'

data/README.md

@@ -0,0 +1,107 @@
+# SeedFormatter
+
+SeedFormatter is a small gem I created while I was working on various projects with terrible, terrible Seed files.
+
+## Purpose
+
+The goal of SeedFormatter is to provide some commonly required functionality to be used in Seed files.
+
+## Dependencies
+
+SeedFormatter uses the [colored](https://github.com/defunkt/colored) gem to present output.
+
+## Example: Seed file layout
+
+I like my seed files to follow this format:
+
+```ruby
+class Seed
+  class << self
+    def create_categories
+      # create some categories here
+    end
+
+    def create_admin_user
+      # create an admin user here
+    end
+  end  
+end
+
+Seed.create_categories
+Seed.create_admin_user
+```
+
+I find this to be the neatest way to write Seed files.
+
+## Example: Output
+
+SeedFormatter provides four methods of showing output:
+
+- `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.
+- `spacer` Just to add a single space to separate groups of functionality.
+
+Using these functions is straight forward (if we use the above example Seed file layout):
+
+```ruby
+class Seed
+  class << self
+    include SeedFormatter
+
+    def create_categories
+      message "Creating some categories"
+
+      ["Sedan", "SUV", "Hatchback"].each do |category_name|
+        category = Category.create :name => category_name        
+        if category.valid?
+          success "Created #{category_name}"
+        else
+          error "Failed to create #{category_name}. Errors: #{category.errors.full_messages}"
+        end
+      end
+
+      spacer
+    end
+  end
+end
+```
+
+## Example: Overriding the display of output
+
+You can override the display of output with the following options:
+
+- `:prefix` Pass in a string to prefix the output. 
+- `:suffix` Pass in a string to suffix the output. 
+- `:color` Pass in a symbol representing the color your want the ouput to be. The list of acceptable colors can be found in colored gem's [documentation](https://github.com/defunkt/colored/blob/master/lib/colored.rb).  
+
+So, there are three methods of customizing the output of SeedFormatter.
+
+1: Pass in the options
+
+```ruby
+success "I did it…they're all trees", {:prefix => "!!!", :suffix => "'''", :color => :magenta}
+```
+
+Which will yield the string `!!!I did it…they're all trees'''` in magenta.
+
+2: Override the default function in your file or similarly,
+
+3: Write your own
+
+```ruby
+def success message, options={}
+  options[:prefix] ||= "!!!"
+  options[:suffix] ||= "'''"
+  options[:color]  ||= :magenta
+  output message, options
+end
+
+def my_custom_output message, options={}
+  options[:prefix] ||= "> "
+  options[:suffix] ||= " <"
+  options[:color]  ||= :yellow
+  output message, options
+end
+```
+

data/Rakefile

@@ -1,8 +1 @@
 require 'bundler/gem_tasks'
-
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-end
-
-desc "Run tests"
-task :default => :test

data/lib/seed_formatter/version.rb

@@ -1,3 +1,3 @@
 module SeedFormatter
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/seed_formatter.rb

@@ -2,6 +2,7 @@ require "seed_formatter/version"
 require "colored"
 
 module SeedFormatter
+  
   # Outputs a message with a set of given options
   #
   # @param [String] message: The message to format
@@ -13,8 +14,9 @@ module SeedFormatter
   # @example Print out an error message
   #   SeedFormatter.output "Some error", {:prefix => "!!! ", :color => :red}
   #   # outputs "!!! Some error" in red text
-  def output message, options
-    puts "#{options[:prefix]}#{message}#{options[:suffix]}".send(options[:color])
+  def output message, options = {}
+    options[:color] ||= :white
+    $stdout.puts "#{options[:prefix]}#{message}#{options[:suffix]}".send(options[:color])
   end
   
   # A preset formatter with overridable options
@@ -39,6 +41,20 @@ module SeedFormatter
   end
   
   def spacer
-    puts ""
+    $stdout.puts ""
+  end
+
+  # Allows you to run a block on each section of a .yml file.
+  #
+  # @param [String] path: The full path of the .yml file
+  def load_yaml_file path
+    begin
+      items = YAML::load(File.read(path))
+      items.each do |hash|
+        yield(hash)
+      end
+    rescue
+      error "Unable to load YAML file #{path}, exception: #{$!}"
+    end
   end
 end

data/seed_formatter.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |s|
   s.version     = SeedFormatter::VERSION
   s.authors     = ["Jordan Maguire"]
   s.email       = ["jmaguire@thefrontiergroup.com.au"]
-  s.homepage    = "https://github.com/jordanmaguire/jordanmaguire.github.com"
-  s.summary     = "summary"
+  s.homepage    = "https://github.com/jordanmaguire/seed_formatter"
+  s.summary     = "Easily format the output of your seeds and parse YAML files"
   s.description = "Easily format the output of your seeds and parse YAML files"
 
   s.files         = `git ls-files`.split("\n")

data/spec/spec_helper.rb

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

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: seed_formatter
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 25
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Jordan Maguire
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-31 00:00:00 +08:00
+date: 2012-02-03 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: colored
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -40,13 +43,17 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
+- .rvmrc
 - Gemfile
+- README.md
 - Rakefile
 - lib/seed_formatter.rb
 - lib/seed_formatter/version.rb
 - seed_formatter.gemspec
+- spec/spec_helper.rb
 has_rdoc: true
-homepage: https://github.com/jordanmaguire/jordanmaguire.github.com
+homepage: https://github.com/jordanmaguire/seed_formatter
 licenses: []
 
 post_install_message: 
@@ -55,25 +62,29 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: summary
-test_files: []
-
+summary: Easily format the output of your seeds and parse YAML files
+test_files: 
+- spec/spec_helper.rb