partial_menu 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 497fcb02fc093221933584484fc1bee9994a6117
+  data.tar.gz: 7ac39d10ef5207c92b7bc049619bcee9748abca9
+SHA512:
+  metadata.gz: 7462b4e8009ec5acbbc8e94f36ef1d4e6b2bcda277eca8d92fd548e7668086db0c8230a85a7339a8879aaa9d3bfbdad12893513a3f115ca49d750d20d7813e35
+  data.tar.gz: 419e533d62c76d7d4fd87ca9964883fd0c65f91fce0cd6e6eeb8fc87e00bfbfcca1af7d0949ae87ecb4ac3ae4e0119a2b8b571d604de600d065517e8785ee716

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Peter Nagy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# PartialMenu
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'partial_menu'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install partial_menu
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PartialMenu'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/generators/views/USAGE

@@ -0,0 +1,20 @@
+Description:
+    Generates the example partial erb templates in /app/views/main_menu/.
+    You can customize the folder by providing the '--partial_dir' or '-d' option
+
+Examples:
+    rails generate partial_menu:views
+
+    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/_submenu_item.html.erb -- submenu root template
+        app/views/main_menu/_item.html.erb         -- submenu items template
+
+    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/_submenu_item.html.erb -- submenu root template
+        app/views/side_menu/_item.html.erb         -- submenu items template

data/lib/generators/views/templates/_item.html.erb

@@ -0,0 +1,12 @@
+<li <%= 'class="active"' if current_menu?(item.uri)%>>
+  <% if item.try(:icon).present? %>
+    <i class="fa fa-fw <%= item.icon %>"></i>
+  <% end %>
+  <% if item.uri.present? %>
+    <%= link_to item.uri do -%>
+      <%= item.title %>
+    <% end -%>
+  <% else %>
+    <%= item.title %>
+  <% end -%>
+</li>

data/lib/generators/views/templates/_menu.html.erb

@@ -0,0 +1,9 @@
+<ul>
+  <% menu.items.each do |item| %>
+    <% if item.has_submenu? %>
+      <%= render "#{menu.type}_menu/submenu", menu: item.submenu %>
+    <% else %>
+      <%= render "#{menu.type}_menu/item", item: item %>
+    <% end %>
+  <% end %>
+</ul>

data/lib/generators/views/templates/_submenu.html.erb

@@ -0,0 +1,12 @@
+<li class="nav-item" title="<%= menu.parent.title %>" data-original-title="<%= menu.parent.title %>">
+  <a class="nav-link nav-link-collapse collapsed" data-toggle="collapse"
+    href="#collapse<%= menu.id %>"  data-parent="#<%= menu.type%>">
+    <% if menu.parent.try(:icon).present? %>
+      <i class="fa fa-fw <%= menu.parent.icon %>"></i>
+    <% end -%>
+    <span class="nav-link-text"><%= menu.parent.title %></span>
+  </a>
+  <% menu.items.each do |item| %>
+    <%= render "#{menu.type}_menu/submenu_item", item: item %>
+  <% end %>
+</li>

data/lib/generators/views/templates/_submenu_item.html.erb

@@ -0,0 +1,12 @@
+<li <%= 'class="active"' if current_menu?(item.uri)%>>
+  <% if item.try(:icon).present? %>
+    <i class="fa fa-fw <%= item.icon %>"></i>
+  <% end %>
+  <% if item.uri.present? %>
+    <%= link_to item.uri do -%>
+      <%= item.title %>
+    <% end -%>
+  <% else %>
+    <%= item.title %>
+  <% end -%>
+</li>

data/lib/generators/views/views_generator.rb

@@ -0,0 +1,17 @@
+module PartialMenu
+  # Generates views on demand and puts them on app/views/partial_menu
+  class ViewsGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    # rubocop:disable Metrics/LineLength
+    class_option :partial_dir,
+                 type: :string,
+                 default: 'main',
+                 aliases: '-d',
+                 desc: 'The directory in the /app/views/ folder to put templates in.'
+    # rubocop:enable Metrics/LineLength
+    def copy_templates
+      @dir = options['partial_dir']
+      directory '.', "app/views/#{@dir}_menu"
+    end
+  end
+end

data/lib/generators/yaml/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Generates an example menu description yaml file for 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
+
+Examples:
+    rails generate partial_menu:yaml
+
+    This will create:
+        config/main_menu.yaml
+
+    rails generate partial_menu:yaml -t side
+
+    This will create:
+        config/side_menu.yaml

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

@@ -0,0 +1,13 @@
+---
+menu:
+  - first_item:
+    title: "First item"
+    uri: root_path
+    icon: test
+  - second_item: separator
+  - third_item:
+    menu:
+    - first_submenu: link
+    - second_submenu:
+      title: menu.second_submenu.title
+      uri: second_path

data/lib/generators/yaml/yaml_generator.rb

@@ -0,0 +1,16 @@
+module PartialMenu
+  # Generates example menu.yml file in config/
+  class YamlGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    class_option :type,
+                 type: :string,
+                 default: 'main',
+                 aliases: '-t',
+                 desc: 'Creates the menu descriptor in /config/{type}_menu.yml'
+
+    def create_menu_yaml
+      @type = options['type']
+      copy_file 'menu.yml', "config/#{@type}_menu.yml"
+    end
+  end
+end

data/lib/partial_menu.rb

@@ -0,0 +1,9 @@
+# PartailMenu implementation class
+module PartialMenu
+end
+
+if defined?(Rails::Railtie)
+  require 'partial_menu/railtie'
+elsif defined?(Rails::Initializer)
+  raise 'partial_menu is not compatible with Rails 2.3 or older'
+end

data/lib/partial_menu/menu.rb

@@ -0,0 +1,37 @@
+require 'partial_menu/menu_item'
+
+module PartialMenu
+  # Represents a menu with menu items
+  class Menu
+    attr_reader :type
+    attr_reader :items
+    attr_reader :parent
+    attr_reader :id
+
+    def initialize(props, type = 'main', parent = nil)
+      raise "Expected a array but got #{props.class}" unless props.is_a? Array
+      raise "Expected a string but got #{type.class}" unless type.is_a? String
+      @type = type
+      @items = []
+      @parent = parent
+      set_id
+      add_items(props)
+    end
+
+    private
+
+    def add_items(items)
+      items.each do |item|
+        @items << PartialMenu::MenuItem.new(item, self)
+      end
+    end
+
+    def set_id
+      @id = if @parent.try(:class) == 'PartialMenu::MenuItem'
+              @parent.id + '_submenu'
+            else
+              @type + '_menu'
+            end
+    end
+  end
+end

data/lib/partial_menu/menu_item.rb

@@ -0,0 +1,83 @@
+module PartialMenu
+  # Represents menu item in a menu
+  class MenuItem
+    attr_reader :type
+    attr_reader :parent
+    attr_reader :uri
+    attr_reader :title
+    attr_reader :submenu
+    attr_reader :id
+
+    def initialize(props, parent)
+      raise 'Expected a hash as props' unless props.is_a?(Hash)
+      raise 'Expected a PartialMenu::Menu as parent' unless parent.is_a?(
+        PartialMenu::Menu
+      )
+      @parent = parent
+      @props = props
+      setup
+    end
+
+    def setup
+      set_type
+      set_title
+      set_id
+      set_uri
+      set_submenu
+      set_other_attr
+    end
+
+    def submenu?
+      @submenu != nil
+    end
+
+    def separator?
+      @type == :separator
+    end
+
+    def active?
+      false
+    end
+
+    private
+
+    def set_submenu
+      @submenu = nil
+      return if @props.key?(:menu)
+      @submenu = PartialMenu::Menu.new(
+        @props[:menu],
+        @parent.type,
+        self
+      )
+    end
+
+    def set_type
+      @_first_entry = @props.shift
+      @type = :item
+      @type = @_first_entry[1].to_sym if @_first_entry[1] == 'separator'
+    end
+
+    def set_title
+      @title = ''
+      return unless @type != :separator
+      @title = @props[:title] if @props.key?(:title)
+      @title = @_first_entry[0].to_s.titleize
+    end
+
+    def set_id
+      @id = @_first_entry[0].to_s
+    end
+
+    def set_uri
+      @uri = nil
+      @uri = @props[:uri] if @type != :separator
+    end
+
+    def set_other_attr
+      @props.except(@id, :uri, :title, :menu).each do |name, value|
+        instance_variable_set('@' + name.to_s, value)
+        define_singleton_method(name) { instance_variable_get("@#{name}") }
+      end
+    end
+  end
+end

data/lib/partial_menu/railtie.rb

@@ -0,0 +1,17 @@
+require 'partial_menu/view_helpers'
+
+module PartialMenu
+  # Binding to Rails
+  class Railtie < ::Rails::Railtie
+    initializer 'partial_menu.view_helpers' do
+      ActiveSupport.on_load(:action_view) do
+        PartialMenu::ViewHelpers
+      end
+    end
+
+    generators do
+      require 'generators/yaml/yaml_generator'
+      require 'generators/views/views_generator'
+    end
+  end
+end

data/lib/partial_menu/version.rb

@@ -0,0 +1,3 @@
+module PartialMenu
+  VERSION = '0.3.0'.freeze
+end

data/lib/partial_menu/view_helpers.rb

@@ -0,0 +1,60 @@
+require 'partial_menu/menu'
+
+module PartialMenu
+  # = PartialMenu view helpers
+  #
+  # This module serves for availability in ActionView templates. It also adds a
+  # new view helper: +partial_menu+.
+  #
+  # == Using the helper without arguments
+  # If the helper is called without passing in the type, it will
+  # render the default menu using the default view partials.
+  #
+  # Example:
+  #
+  #   <%= partial_menu %>
+  #
+  # ... will result in <tt>menu.yaml</tt> getting displayed using partials
+  # from +app/views/partial_menu+:
+  #
+  #  <ul>
+  #    <li><a href="/">First item</a></li>
+  #    ...
+  #  </ul>
+  #
+  # Any options defined in the call will be send to +render+ as local variables
+  #
+  # Example:
+  #
+  #   <%= partial_menu 'menu', {menu_id:'sidemenu'} %>
+  #
+  # You can leave out menu type parameter:
+  #
+  # Example:
+  #
+  #   <%= partial_menu {menu_id:'sidemenu'} %>
+  #
+  module ViewHelpers
+    def partial_menu(type = 'main', options = {}) #:nodoc:
+      if type.is_a? Hash
+        options = type
+        type = 'main'
+      end
+      options[:menu] = PartialMenu::Menu.new(load_menu_from_yaml(type))
+      options.symbolize_keys!
+      render partial: "#{type}_menu/menu", locals: options
+    end
+
+    def current_menu?(path)
+      request.path == URI(path).path unless path.blank?
+    end
+
+    private
+
+    def load_menu_from_yaml(type)
+      Psych.load_file(
+        Rails.root.join("config/#{type}_menu.yml")
+      ).deep_symbolize_keys[:menu]
+    end
+  end
+end

data/lib/tasks/partial_menu_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :partial_menu do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: partial_menu
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Peter Nagy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: minitest-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+- !ruby/object:Gem::Dependency
+  name: rails_best_practices
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: |-
+  Generating hierarchical meus in Rails should utilize Rails'
+    built-in partial views instead of using some kind on HTML code generators.
+    This gem just do that.
+email:
+- peter@meter-reader.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/views/USAGE
+- lib/generators/views/templates/_item.html.erb
+- lib/generators/views/templates/_menu.html.erb
+- lib/generators/views/templates/_submenu.html.erb
+- lib/generators/views/templates/_submenu_item.html.erb
+- lib/generators/views/views_generator.rb
+- lib/generators/yaml/USAGE
+- lib/generators/yaml/templates/menu.yml
+- lib/generators/yaml/yaml_generator.rb
+- lib/partial_menu.rb
+- lib/partial_menu/menu.rb
+- lib/partial_menu/menu_item.rb
+- lib/partial_menu/railtie.rb
+- lib/partial_menu/version.rb
+- lib/partial_menu/view_helpers.rb
+- lib/tasks/partial_menu_tasks.rake
+homepage: https://bitbucket.org/meterreader/partial_menu
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Navigation menu builder based on Rails partial views.
+test_files: []