partial_menu 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51707929a107b5a59d3fc4ccce357f1a8833ec79
-  data.tar.gz: cc8327e327f9ab7fcc716003d320dd2f5133408b
+  metadata.gz: 2714223d904bafa97e9f92736314f96bf06f6e66
+  data.tar.gz: 85215decc146153e1873d643563f502991c87868
 SHA512:
-  metadata.gz: e811b68b27e208262c1d56a3928b33cae54492b2fc0d6b66dbb878e8d82e5c075b467141b99cd12375da9dbd3eacbf470af04e5d0c4adc30ccef8f1d20c97824
-  data.tar.gz: 32c9fd3d571ac174e7f63c5e8dd3b1e3824dd0e08fcb97085eaed7c961b7dde4d1dbad6c75a40653d89fbf26cc025a826a16be11c813e200078ad2835f359c7e
+  metadata.gz: 6a2ec14fb7443b91e39d4fab6def404cc89dfaf76ad7e36db48ad0946d610ab8c9443096926abc39bc942232f33de82a12568683c4c5fa2f5182e48bb9b0bc8f
+  data.tar.gz: 1a879c100269a83d747b20fdb4c0dcafff8c612b5dfc46b38c892425cb2a19847b0a61aa87119b686e792e40ba9259f129356585093bf82871d1ec99e9b44042

data/README.md

@@ -1,8 +1,50 @@
 # PartialMenu
-Short description and motivation.
+Generating hierarchical menus in Rails should utilize Rails' built-in partial views instead of using some kind on HTML code generators. This gem just do that.
 
 ## Usage
-How to use my plugin.
+After installing the gem you can generate the views and the config file to create your own menus, even more than one can be generated by using name prefixes.
+
+```bash
+rails generate partial_menu:yaml
+```
+This will generate an example menu description yaml file in `config/main_menu.yaml`
+
+You can have multiple menu definitiions in an app. For this you can use the `--type` parameter to set the name of the file
+
+```bash
+rails generate partial_menu:yaml -t side
+```
+This will create `config/side_menu.yaml`
+
+You can define your menu structure in the generated yaml file:
+```yml
+---
+menu:                                   # Marks the beginnin of the menu
+  - first_item:                         # Adds a menu item. Text here will be parsed as id for the item.
+    title: "First item"                 # Optional title of the item. If not set, ID will be used
+    uri: root                           # Optional URI, in any format url_for would parse
+    icon: test                          # Optional icon for the item.
+  - second_item: separator              # A second menu item, specifing that its just a separator.
+  - third_item:
+    icontype: glyph                     # You can add any arbitarty property to an item, it will be parsed and can be used in templates.
+    menu:                               # Here comes the submenu
+    - first_submenu: link               # First submenu, with specifing its link as a shortcut.
+    - second_submenu:
+      title: menu.second_submenu.title  # You can use any text as title. In your template you can use it as you whish, like translate it with I18N::t()
+      uri: second
+
+```
+Now about the views:
+
+```bash
+    rails generate partial_menu:views -d side
+```
+This will create:
+ - `app/views/side_menu/_menu.html.erb`         -- menu root template
+ - `app/views/side_menu/_item.html.erb`         -- menu items template
+ - `app/views/side_menu/_separator.html.erb`    -- separator template
+ - `app/views/side_menu/_submenu_item.html.erb` -- submenu root template
+ - `app/views/side_menu/_item.html.erb`         -- submenu items template
 
 ## Installation
 Add this line to your application's Gemfile:

data/lib/generators/views/USAGE

@@ -8,6 +8,7 @@ Examples:
     This will create:
         app/views/main_menu/_mneu.html.erb         -- menu root template
         app/views/main_menu/_item.html.erb         -- menu items template
+        app/views/main_menu/_separator.html.erb    -- separator template
         app/views/main_menu/_submenu_item.html.erb -- submenu root template
         app/views/main_menu/_item.html.erb         -- submenu items template
 
@@ -16,5 +17,6 @@ Examples:
     This will create:
         app/views/side_menu/_menu.html.erb         -- menu root template
         app/views/side_menu/_item.html.erb         -- menu items template
+        app/views/side_menu/_separator.html.erb    -- separator template
         app/views/side_menu/_submenu_item.html.erb -- submenu root template
         app/views/side_menu/_item.html.erb         -- submenu items template

data/lib/generators/yaml/USAGE

@@ -1,5 +1,5 @@
 Description:
-    Generates an example menu description yaml file for config/main_menu.yaml
+    Generates an example menu description yaml file at config/main_menu.yml
     You can have multiple menu definitiions in an app. For this you can use
     the '--type' parameter to set the name of the file
 
@@ -10,6 +10,7 @@ Examples:
         config/main_menu.yaml
 
     rails generate partial_menu:yaml -t side
+    rails generate partial_menu:yaml --type side
 
     This will create:
-        config/side_menu.yaml
+        config/side_menu.yml

data/lib/generators/yaml/templates/menu.yml

@@ -2,7 +2,7 @@
 menu:
   - first_item:
     title: "First item"
-    uri: root_path
+    uri: root
     icon: test
   - second_item: separator
   - third_item:
@@ -11,4 +11,4 @@ menu:
     - first_submenu: link
     - second_submenu:
       title: menu.second_submenu.title
-      uri: second_path
+      uri: second

data/lib/partial_menu/version.rb

@@ -1,3 +1,3 @@
 module PartialMenu
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: partial_menu
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Peter Nagy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-14 00:00:00.000000000 Z
+date: 2018-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_link_to
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 description: |-
-  Generating hierarchical meus in Rails should utilize Rails'
+  Generating hierarchical menus in Rails should utilize Rails'
     built-in partial views instead of using some kind on HTML code generators.
     This gem just do that.
 email: