seed_helper 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b6801bad83d64424d161ad01be18c13d0fae475
-  data.tar.gz: 01a9e795f032a20a0e4f43d40cc04389605195cf
+  metadata.gz: 0d7e9d6d141f681c24a934407abeb4e7aaf8b6d2
+  data.tar.gz: 05824d17371bdd9bde055e14033c6c050741325c
 SHA512:
-  metadata.gz: 41df7cd2622c66101f3947c43301d9486237bb5a8c72ef508d4a528dd6a83a356c13e56c52c505f6a0b2b72a0217aa9f3729a6f02f06daaa0ba72d5755f4aee2
-  data.tar.gz: 0b6e0e3d39a7c9f81c7d6035c2dcd2b142239ab90065a5fdcafbd2c2768fd67b368390443ca54f67b29930db46f842e9ef424215f616660a4ba70b34a9ca731f
+  metadata.gz: 43917e8c11cf6db506213a8afb5758c0e94616283a558e44547873e6f2c226e075d86bf076afadc3c6fc740ca153f3fbc42a480498d858bd232d3bf4cf288eff
+  data.tar.gz: cd41a546218f3627b3cd713359b2f52693e4807fa21fb9183ffab8d5e57a8085782e51ff07d82061f0e9181190ec0ca24fe5918e75dcf1a630783338f775065a

data/README.md

@@ -62,3 +62,22 @@ SeedHelper provides multiple methods for showing output that can be used outside
 - `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.
+
+## Example: Creating a rake task
+
+SeedHelper gives you an easy way to create consistently named rake tasks. Usage is as follows:
+
+```ruby
+# rake db:seed:task_name
+# :environment is automatically added as a dependency
+SeedHelper.create_seed_task(:task_name)
+
+# rake db:seed:second_task_name
+# Dependent on :task_name, rake db:seed:task_name will be run before :second_task_name
+SeedHelper.create_seed_task(:second_task_name, [:task_name])
+
+# rake db:seed:third_task_name
+# No dependencies (other than environment) but with a custom title. This will show up as
+# description of task in `rake -T` and will be printed to screen when task runs
+SeedHelper.create_seed_task(:third_task_name, [], "My sick name")
+```

data/lib/seed_helper/rake_helper.rb

@@ -4,12 +4,13 @@ module SeedHelper::RakeHelper
 
   include Rake::DSL
 
-  def create_seed_task(task_name, dependencies=[], &task)
+  def create_seed_task(task_name, dependencies=[], title="", &task)
     namespace :db do
       namespace :seed do
-        desc "Creating #{task_name.to_s.humanize}"
+        seed_title = title.empty? ? "Creating #{task_name.to_s.humanize}" : title
+        desc(seed_title)
         task task_name => dependencies.append(:environment) do
-          message task_name.to_s.humanize
+          message title
 
           task.call
 

data/lib/seed_helper/version.rb

@@ -1,3 +1,3 @@
 class SeedHelper
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seed_helper
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Jordan Maguire