handy_generators 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7d113f211bbdd551a0fd23fec01458efd1d89b4499716f9680c9c90dffa25a1
-  data.tar.gz: 8db9774519f008564b2416c58dfea6941a1d687eb4bb0fa4e7a30647e385d0d9
+  metadata.gz: '064052909f23ec9f06d4b1308de4ef98a9f73c860207e2d38f1903e82df94af9'
+  data.tar.gz: 89f7acd9cc438f741c0155ee3521b28134504208146109550dd62fc0459f8164
 SHA512:
-  metadata.gz: e1fc413a078fd5f613c4223b8972b7d6c37e4782eefb59b4dbd01c7e941d0f63ac3958188d8a8aab19596febf91b66898822128d544785f6a720f09da08ce233
-  data.tar.gz: e1adc6a24e7cd2573a2c23299558546fb6008803744e87fe974256da11033f5eb7c66dbeb8b0b14b284f15cc40e0fd278c187a716e019a48f8c0d39918f8dc49
+  metadata.gz: 76226312f7984709f22816bb69a5962146d4ab29cf8e8e7687681c4331847da8df0125da2fe6814ec0497d08ad46c28cdba09d5b0da9191f6e1d19524f1daaab
+  data.tar.gz: '08af4099ae504214722b233101959ca85892eeb03652127ff32910decfc126c556ca567e694f7ad7dc611de563656619e9c7c601d04adfd585a553a22bb4f45c'

data/Gemfile.lock

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

data/handy_generators.gemspec

@@ -10,7 +10,48 @@ Gem::Specification.new do |spec|
   spec.email         = ["dakotaleemusic@gmail.com"]
 
   spec.summary       = %q{Add rails generators to add a helper to add edit and delete links that work for multiple resources}
-  spec.description   = %q{Run the edit_delete_links generator to add the edit_links helper to your app so you can use pundit (optional) to add edit and delete links to a resource's show page. Just pass the resource as an argument: edit_links(record: @post)}
+  spec.description   = %q{
+    ## Usage
+
+### 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.
+  }
   spec.homepage      = "https://github.com/DakotaLMartinez/handy_generators"
   spec.license       = "MIT"
 

data/lib/handy_generators/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: handy_generators
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - DakotaLMartinez
@@ -80,9 +80,27 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '4.0'
-description: 'Run the edit_delete_links generator to add the edit_links helper to
-  your app so you can use pundit (optional) to add edit and delete links to a resource''s
-  show page. Just pass the resource as an argument: edit_links(record: @post)'
+description: "\n    ## Usage\n\n### Edit Links Helper\n\n#### Generators\n\n```\nrails
+  generate handy_generators:edit_links_helper\n```\n\nThis generator will add a helper
+  and a partial for displaying edit and\ndelete links for a record. This uses pundit
+  by default to check\nwhether a user should be able to edit and/or delete the record
+  before\ndisplaying the link. If you'd like to always display these links when\nyou
+  use the helper in the view or handle the logic yourself, simply\nadd --pundit false
+  to your command.\n\n```\nrails generate handy_generators:edit_links_helper --pundit
+  false\n```\n\n#### Helpers\n\n`edit_links(record:, edit_classes: '', delete_classes:
+  '')`\n\nThe `edit_links` helper receives three parameters `record`, `edit_classes`,
+  \nand `delete_classes`. Record is the only required parameter, \n`edit_classes`
+  and `delete_classes` will be empty by default, if you'd \nlike to add classes you
+  can pass them as parameters to the helper. The \ndefault helper uses pundit, and
+  it will check if the logged in user has\npermission to edit or delete the record
+  before displaying the links. If\nnot, it will display the edit or delete links to
+  all users.\n\n`edit_record_link(record:, classes: '')`\n\nThe `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.\n\n`delete_record_link(record:, classes: '')`\n\nThe `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.\n  "
 email:
 - dakotaleemusic@gmail.com
 executables: []