seed_helper 1.3.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 8b6801bad83d64424d161ad01be18c13d0fae475
4
- data.tar.gz: 01a9e795f032a20a0e4f43d40cc04389605195cf
3
+ metadata.gz: 0d7e9d6d141f681c24a934407abeb4e7aaf8b6d2
4
+ data.tar.gz: 05824d17371bdd9bde055e14033c6c050741325c
5
5
  SHA512:
6
- metadata.gz: 41df7cd2622c66101f3947c43301d9486237bb5a8c72ef508d4a528dd6a83a356c13e56c52c505f6a0b2b72a0217aa9f3729a6f02f06daaa0ba72d5755f4aee2
7
- data.tar.gz: 0b6e0e3d39a7c9f81c7d6035c2dcd2b142239ab90065a5fdcafbd2c2768fd67b368390443ca54f67b29930db46f842e9ef424215f616660a4ba70b34a9ca731f
6
+ metadata.gz: 43917e8c11cf6db506213a8afb5758c0e94616283a558e44547873e6f2c226e075d86bf076afadc3c6fc740ca153f3fbc42a480498d858bd232d3bf4cf288eff
7
+ data.tar.gz: cd41a546218f3627b3cd713359b2f52693e4807fa21fb9183ffab8d5e57a8085782e51ff07d82061f0e9181190ec0ca24fe5918e75dcf1a630783338f775065a
data/README.md CHANGED
@@ -62,3 +62,22 @@ SeedHelper provides multiple methods for showing output that can be used outside
62
62
  - `error` Indicates a seed function has failed. Red by default.
63
63
  - `resource_already_exists` Indicates that the data already exists in the database.
64
64
  - `special_message` Show a purple multiline message. I use this to show logins for seed users.
65
+
66
+ ## Example: Creating a rake task
67
+
68
+ SeedHelper gives you an easy way to create consistently named rake tasks. Usage is as follows:
69
+
70
+ ```ruby
71
+ # rake db:seed:task_name
72
+ # :environment is automatically added as a dependency
73
+ SeedHelper.create_seed_task(:task_name)
74
+
75
+ # rake db:seed:second_task_name
76
+ # Dependent on :task_name, rake db:seed:task_name will be run before :second_task_name
77
+ SeedHelper.create_seed_task(:second_task_name, [:task_name])
78
+
79
+ # rake db:seed:third_task_name
80
+ # No dependencies (other than environment) but with a custom title. This will show up as
81
+ # description of task in `rake -T` and will be printed to screen when task runs
82
+ SeedHelper.create_seed_task(:third_task_name, [], "My sick name")
83
+ ```
@@ -4,12 +4,13 @@ module SeedHelper::RakeHelper
4
4
 
5
5
  include Rake::DSL
6
6
 
7
- def create_seed_task(task_name, dependencies=[], &task)
7
+ def create_seed_task(task_name, dependencies=[], title="", &task)
8
8
  namespace :db do
9
9
  namespace :seed do
10
- desc "Creating #{task_name.to_s.humanize}"
10
+ seed_title = title.empty? ? "Creating #{task_name.to_s.humanize}" : title
11
+ desc(seed_title)
11
12
  task task_name => dependencies.append(:environment) do
12
- message task_name.to_s.humanize
13
+ message title
13
14
 
14
15
  task.call
15
16
 
@@ -1,3 +1,3 @@
1
1
  class SeedHelper
2
- VERSION = "1.3.0"
2
+ VERSION = "1.4.0"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: seed_helper
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.3.0
4
+ version: 1.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jordan Maguire