plant 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 347097da4cb94c38e919978e527dd0093c8bd726
-  data.tar.gz: 08af0ca4e063794b03d9b54dec568b112914c8e7
+  metadata.gz: b1942967aeeab9dd650cedace8e56a62da4af213
+  data.tar.gz: 631ab72e1d8a5cb473c106637dfd37b2566fef77
 SHA512:
-  metadata.gz: c256b54ae7808907aed2e994f524456fb23b07c59bf9f28f181236663946eae5a149e6edeab48a1cd587319081685535f896626465ef30fce3150b02f6056ee4
-  data.tar.gz: e88d69778788306ca9003b8d3cf14769c50428d3a7e6eb64378429dc1a0704b662a258f51a702c6be3a5afa6dcf185724b9e1de02f7c882d534483f285100fbe
+  metadata.gz: 2e52cc5327cd5d737bcf11d07325abc62d37b33ca817d617c8a227a1ddc478818fc5b0d4c50e9449e8746797cc823ad6dc927aaf0b027d8eb485de7dc6cc2618
+  data.tar.gz: a6634e55098fd04029326430c5f24f548c757257f3f58ff485a1f734b464886f5e160627b38cc39eabc16151217a013fed50b99bd0d83affef84a0347fbfa302

data/README.md

@@ -0,0 +1,87 @@
+# Plant
+
+## Dont just seed, plant.
+
+This gem allows you to define your content in yaml files, then to be
+loaded into the database by a rake task. You then get source control on
+your yml files, with the flexibility of being able to use a databse
+searching engine to search for content.
+
+## Installation
+
+Add to your gem file:
+
+gem 'plant'
+
+run `bundle install`
+
+Then copy the migrations over and run them
+`rake plant:install:migrations `
+`rake db:migrate`
+
+## Usage
+
+Add your content to app/content/any/path/blah.yml, plant will pick
+up on any yml files in app/content.
+
+With some content added run:
+`rake plant:seed`
+
+You can run this as many times as you like and the content will be
+replaced with tah in your yaml file.
+
+No to output it onto your page, simply use the helper:
+
+= plant_content_for('any.path.blah.key', { scenario: current_user })
+
+You can pass any argument as the scenario argument, plant will call
+`.scenario` on it. So if you define a method in your user model called
+scenario, this will be appended to the node search string:
+
+```
+  class User
+     def scenario
+        'fish'
+     end
+  end
+```
+
+=> plant_content_for('red.buses', scenario: current_user)
+will return the content for 'red.buses.fish' if it exists, if not will
+return 'red.buses' or 'red.buses.main'
+
+### Interpolation
+
+When defining content that needs a parameter, you can use standard ruby
+interpolation i.e. #{name} but with SINGLE quotes, otherwise the
+interpolation will be injected at yaml load time, which will be nil,
+rather than at run time. If a content is defined as:
+sample:
+  foo: 'Say hello to #{name}'
+Calling plant_content_for('sample.foo', name: 'George') will return 'Say
+hello to George'
+
+### HTML
+
+If you want to include HTML in your content, you can. But when outputing
+on to the page, you need to pass in html_safe.
+=> plant_content_for('sample.link', html_safe: true)
+
+### Capistrano
+
+To work with capistrano include:
+`require 'capistrano/plant'`
+in your Capfile. This is not tested yet. Otherwise take a look at
+lib/capistrano/tasks/plant.rake on how to run rake task on deploy
+
+## Development
+
+To get started, clone the repo and run `bundle install`. This will get
+all the stuff that you need. Then a simple `bundle exec guard` will
+start the guard runner, which watches on rubocop and specs. 
+If you add functionality, please add tests.
+
+Before pushing back to the repo, make sure that all tests pass. 
+
+## Future features / Wish list
+- Use git to find diffs so don't have to load all content every time

data/lib/capistrano/plant.rb

@@ -1 +1 @@
-load File.expand_path("../tasks/plant.rake", __FILE__)
+load File.expand_path('../tasks/plant.rake', __FILE__)

data/lib/plant/version.rb

@@ -1,4 +1,4 @@
 # Version file
 module Plant
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

data/lib/tasks/plant_tasks.rake

@@ -9,6 +9,6 @@ namespace :plant do
       content_obj.save!
       count += 1
     end
-    puts 'Planted #{count} seeds.'
+    puts "Planted #{count} seeds."
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plant
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Yule
@@ -171,6 +171,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - Rakefile
 - app/helpers/plant/plant_helper.rb
 - app/models/plant/content.rb
@@ -183,7 +184,7 @@ files:
 - lib/plant/utils.rb
 - lib/plant/version.rb
 - lib/tasks/plant_tasks.rake
-homepage: http://www.dryule.com
+homepage: https://rubygems.org/gems/plant
 licenses:
 - MIT
 metadata: {}