handy_generators 0.1.2 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcf3d89962e30889ab8c36e231d46468202b02ac160b5625a11e70032805475c
-  data.tar.gz: 874a43d1680a71c25d5dc9afc61cbb8ff6a7dfa6c9eb0ce890333bf7fc00a296
+  metadata.gz: d7d113f211bbdd551a0fd23fec01458efd1d89b4499716f9680c9c90dffa25a1
+  data.tar.gz: 8db9774519f008564b2416c58dfea6941a1d687eb4bb0fa4e7a30647e385d0d9
 SHA512:
-  metadata.gz: 724b65ddc218cee6bf02df0b2baa17740f7b2236929cc2f61ddf412806548a6dfc5f995c2512cf0d09c6d78f9030145f17e34387aa7e0f2c84a5998a53223e7f
-  data.tar.gz: f8ca90337a8cbe3dc9ba1b2d9d9b8872f1e68bd6f76a46b2b96f34881b05d1c54b333243ce8e581944dd6153c571119fd147bd36263e0f22f1942b62e49dfe9d
+  metadata.gz: e1fc413a078fd5f613c4223b8972b7d6c37e4782eefb59b4dbd01c7e941d0f63ac3958188d8a8aab19596febf91b66898822128d544785f6a720f09da08ce233
+  data.tar.gz: e1adc6a24e7cd2573a2c23299558546fb6008803744e87fe974256da11033f5eb7c66dbeb8b0b14b284f15cc40e0fd278c187a716e019a48f8c0d39918f8dc49

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    handy_generators (0.1.2)
+    handy_generators (0.1.8)
       rails (> 4.0)
 
 GEM

data/README.md

@@ -1,8 +1,6 @@
 # HandyGenerators
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/handy_generators`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem adds some handy generators to your Rails app. 
 
 ## Installation
 
@@ -22,7 +20,44 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Edit Links Helper
+
+#### Generators
+
+```
+rails generate handy_generators:edit_links_helper
+```
+
+This generator will add a helper and a partial for displaying edit and
+delete links for a record. This uses pundit by default to check
+whether a user should be able to edit and/or delete the record before
+displaying the link. If you'd like to always display these links when
+you use the helper in the view or handle the logic yourself, simply
+add --pundit false to your command.
+
+```
+rails generate handy_generators:edit_links_helper --pundit false
+```
+
+#### Helpers
+
+`edit_links(record:, edit_classes: '', delete_classes: '')`
+
+The `edit_links` helper receives three parameters `record`, `edit_classes`, 
+and `delete_classes`. Record is the only required parameter, 
+`edit_classes` and `delete_classes` will be empty by default, if you'd 
+like to add classes you can pass them as parameters to the helper. The 
+default helper uses pundit, and it will check if the logged in user has
+permission to edit or delete the record before displaying the links. If
+not, it will display the edit or delete links to all users.
+
+`edit_record_link(record:, classes: '')`
+
+The `edit_record_link` helper will just display an edit link, it won't check if the user has permission before displaying the link. Classes that you pass in as a parameter will be applied to the link.
+
+`delete_record_link(record:, classes: '')`
+
+The `delete_record_link` helper will display just display a delete link, with a confirm. It also doesn't check if the user has permission before displaying the link. Classes that you pass in as a parameter will be applied to the link.
 
 ## Development
 

data/lib/edit_links_helper/USAGE

@@ -0,0 +1,14 @@
+Description:
+    This generator will add a helper and a partial for displaying edit and 
+    delete links for a record. This uses pundit by default to check
+    whether a user should be able to edit and/or delete the record before
+    displaying the link. If you'd like to always display these links when 
+    you use the helper in the view or handle the logic yourself, simply
+    add --pundit false to your command.
+
+Example:
+    rails generate edit_links_helper add [--pundit false]
+
+    This will create:
+        app/helpers/edit_delete_links_helper.rb
+        app/views/shared/_edit_delete_links.html.erb

data/lib/{generators → edit_links_helper}/edit_links_helper_generator.rb

@@ -1,5 +1,5 @@
 class HandyGenerators::EditLinksHelperGenerator < Rails::Generators::Base
-  source_root File.expand_path('templates/edit_delete_links', __dir__)
+  source_root File.expand_path('templates', __dir__)
   class_option :pundit, type: :boolean, default: true
 
   def generate

data/lib/handy_generators.rb

@@ -2,5 +2,5 @@ require "handy_generators/version"
 
 module HandyGenerators
   require "rails/generators"
-  require_relative "./generators/edit_links_helper_generator"
+  require_relative "./edit_links_helper/edit_links_helper_generator"
 end

data/lib/handy_generators/version.rb

@@ -1,3 +1,3 @@
 module HandyGenerators
-  VERSION = "0.1.2"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: handy_generators
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.8
 platform: ruby
 authors:
 - DakotaLMartinez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-01 00:00:00.000000000 Z
+date: 2018-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,11 +99,11 @@ files:
 - bin/console
 - bin/setup
 - handy_generators.gemspec
-- lib/generators/USAGE
-- lib/generators/edit_links_helper_generator.rb
-- lib/generators/templates/edit_delete_links/edit_delete_links_helper.template
-- lib/generators/templates/edit_delete_links/edit_delete_links_partial.template
-- lib/generators/templates/edit_delete_links/edit_delete_links_partial_no_pundit.template
+- lib/edit_links_helper/USAGE
+- lib/edit_links_helper/edit_links_helper_generator.rb
+- lib/edit_links_helper/templates/edit_delete_links_helper.template
+- lib/edit_links_helper/templates/edit_delete_links_partial.template
+- lib/edit_links_helper/templates/edit_delete_links_partial_no_pundit.template
 - lib/handy_generators.rb
 - lib/handy_generators/version.rb
 homepage: https://github.com/DakotaLMartinez/handy_generators

data/lib/generators/USAGE

@@ -1,12 +0,0 @@
-Description:
-    This generator will add a helper and a partial for displaying edit and delete links 
-    for a record. This uses pundit by default to check whether a user should be able to 
-    edit and/or delete the record before displaying the link. If you'd like to always 
-    display these links when you use the helper in the view or handle the logic yourself, simply add --pundit false to your command.
-
-Example:
-    rails generate edit_links_helper add [--pundit false]
-
-    This will create:
-        app/helpers/edit_delete_links_helper.rb
-        app/views/shared/_edit_delete_links.html.erb