structured_menus 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bf8638465b18ff55d7769def7e225ec37d0a3e4
+  data.tar.gz: 2e7c8564de3bbf3aa00d68a18452197c01700446
+SHA512:
+  metadata.gz: 6c715ac46996d845698dc886904c00c16a8b27dabfc9978a62fa888eb4106885cea33d22be5f77dfdd4df458781448a91c10d805c3b1970564295eae3cd7e08c
+  data.tar.gz: fc3b254949da858edc0deb1a3e438796f7c144bcf27a2f71688f3799af1dc98f99e9f89493e0a7e1ed1140e7ee4c21f31add909fd459e95ae3f288c630c4b805

data/.gitignore

@@ -0,0 +1,2 @@
+.idea/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,66 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+  Exclude:
+    - 'lib/**/*'
+    - 'bin/**/*'
+    - 'script/**/*'
+    - '**/*.json.jbuilder'
+    - 'vendor/bundle/**/*'
+    - 'node_modules/**/*'
+    - 'db/schema.rb' # auto-generated :(
+    - 'Capfile'
+    - 'config/routes.rb'
+    - 'config/initializers/devise.rb'
+    - 'test/**/*'
+    - 'vendor/**/*'
+  TargetRubyVersion: 2.4
+
+Style/SymbolArray:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/FileName:
+  Exclude:
+    - Gemfile
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+  Enabled: true
+Style/NumericPredicate:
+  AutoCorrect: true
+  EnforcedStyle: comparison
+  Enabled: true
+Style/AsciiComments:
+  Enabled: false
+Style/Lambda:
+  EnforcedStyle: literal
+Style/TrivialAccessors:
+  Enabled: false
+
+# Want to refactor some stuff? Remove these.
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 100
+  Exclude:
+    - 'db/migrate/*'
+Metrics/LineLength:
+  Max: 150
+Metrics/ClassLength:
+  Enabled: false
+Metrics/BlockLength:
+  Max: 30
+  ExcludedMethods:
+    - scope
+    - configure
+    - draw
+    - define
+    - test
+    - helpers
+    - field

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 ArtOfCode-
+
+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,14 @@
+# `structured_menus`
+An easy way to create flexible menus for Rails apps.
+
+## Installation
+TBC
+    
+## Usage
+TBC
+
+## Contributions
+Welcome. Ping me a PR. For large changes you should probably open an issue first to discuss.
+
+## License
+Available under the terms of the MIT license.

data/lib/structured_menus/adapters/dashboard_adapter.rb

@@ -0,0 +1,28 @@
+module StructuredMenus::Adapters
+  class DashboardAdapter
+    include ActionView::Helpers::UrlHelper
+    include ActionView::Helpers::OutputSafetyHelper
+
+    # Accepted options:
+    #
+    # :if - only include this menu item if the provided block returns true when passed the current user (if not present, item is always included)
+    # :width - the number of cards to include in one row of the menu (max 12, default 4)
+    # :class - the CSS class to apply to each card's wrapper <div> (default dashboard-menu-card)
+    #
+    # You still need to provide your own styles for .dashboard-menu-card.
+    def self.show(menu, user, **options)
+      inst = new
+      width = options[:width] || 4
+      cards = menu.map do |i|
+        next unless !i['if'] || instance_eval(i['if']).call(user)
+
+        cls = options[:class] || 'dashboard-menu-card'
+        inst.raw("<div class=\"#{cls}\">#{inst.link_to inst.raw("<i class=\"fas fa-#{i['icon']}\"></i> #{i['name']}"), i['link']}</div>")
+      end.compact
+
+      inst.raw(cards.in_groups_of(12 / width).map(&:compact).map do |g|
+        '<div class="row">' + g.map { |c| "<div class=\"col-md-#{12 / width}\">#{c}</div>" }.join("\n") + '</div>'
+      end.join("\n"))
+    end
+  end
+end

data/lib/structured_menus/adapters/dropdown_adapter.rb

@@ -0,0 +1,33 @@
+module StructuredMenus::Adapters
+  class DropdownAdapter
+    include ActionView::Helpers::UrlHelper
+    include ActionView::Helpers::OutputSafetyHelper
+
+    # Accepted options:
+    #
+    # :if - only include this menu item if the provided block returns true when passed the current user (if not present, item is always included)
+    # :include_icon - if true, include a FontAwesome icon (no fa- prefix) as specified by the `icon` property in the menu's YAML (default false)
+    # :include_ul - if true, wrap the dropdown <li> list in a <ul> (default true)
+    #
+    # With :include_icon, you still need to include FontAwesome yourself.
+    # With :include_ul, you still need to add the dropdown's trigger yourself.
+    def self.show(menu, user, **options)
+      inst = new
+      items = menu.map do |i|
+        next unless !i['if'] || instance_eval(i['if']).call(user)
+
+        if !options[:include_icon]
+          inst.raw("<li>#{inst.link_to i['name'], i['link']}</li>")
+        else
+          inst.raw("<li>#{inst.link_to inst.raw("<i class=\"fas fa-#{i['icon']}\"></i> #{i['name']}"), i['link']}</li>")
+        end
+      end.compact
+
+      if options[:include_ul] || options[:include_ul].nil?
+        inst.raw('<ul class="dropdown-menu">' + items.join("\n") + '</ul>')
+      else
+        inst.raw(items.join("\n"))
+      end
+    end
+  end
+end

data/lib/structured_menus/configurator.rb

@@ -0,0 +1,38 @@
+require_relative 'dispatcher'
+require_relative 'adapters/dashboard_adapter'
+require_relative 'adapters/dropdown_adapter'
+
+module StructuredMenus
+  @config = nil
+
+  def self.config
+    @config
+  end
+
+  def self.config=(val)
+    @config = val
+  end
+
+  class Configurator
+    attr_accessor :menus_directory, :adapters
+
+    def initialize
+      @menus_directory = Rails.root.join('app/menus')
+      @adapters = [Adapters::DashboardAdapter, Adapters::DropdownAdapter]
+    end
+
+    def self.configure
+      inst = new
+      yield inst
+      StructuredMenus.config = inst
+
+      Rails.module_eval do
+        @menus = StructuredMenus::Dispatcher.new
+
+        def self.menus
+          @menus
+        end
+      end
+    end
+  end
+end

data/lib/structured_menus/dispatcher.rb

@@ -0,0 +1,23 @@
+module StructuredMenus
+  class Dispatcher
+    def initialize
+      menus_dir = StructuredMenus.config.menus_directory
+      @menus = Dir.entries(menus_dir).reject { |f| File.directory? f }\
+                                     .map { |p| [File.basename(p).gsub('.yml', ''), p] }.to_h.with_indifferent_access
+      @adapters = StructuredMenus.config.adapters.map do |an|
+        if an.class == Class
+          an
+        elsif an.class == String
+          require_relative an
+          File.basename(an).gsub('.rb', '').classify.constantize
+        end
+      end.map { |ac| [ac.name.demodulize.gsub('Adapter', '').underscore, ac] }.to_h.with_indifferent_access
+    end
+
+    def show(name, adapter_name, user, **options)
+      menu = YAML.safe_load(File.read(StructuredMenus.config.menus_directory.join(@menus[name])))
+      adapter = @adapters[adapter_name]
+      adapter.show(menu, user, **options)
+    end
+  end
+end

data/lib/structured_menus/version.rb

@@ -0,0 +1,3 @@
+module StructuredMenus
+  VERSION = '0.0.1'.freeze
+end

data/lib/structured_menus.rb

@@ -0,0 +1,2 @@
+require 'structured_menus/configurator'
+require 'structured_menus/dispatcher'

data/structured_menus.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'structured_menus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'structured_menus'
+  spec.version       = StructuredMenus::VERSION
+  spec.authors       = ['ArtOfCode-']
+  spec.email         = ['hello@artofcode.co.uk']
+
+  spec.summary       = 'An easy way to create flexible menus of things for Rails apps.'
+  spec.homepage      = 'https://github.com/ArtOfCode-/structured_menus'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'rails', '~> 5'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: structured_menus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ArtOfCode-
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: 
+email:
+- hello@artofcode.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/structured_menus.rb
+- lib/structured_menus/adapters/dashboard_adapter.rb
+- lib/structured_menus/adapters/dropdown_adapter.rb
+- lib/structured_menus/configurator.rb
+- lib/structured_menus/dispatcher.rb
+- lib/structured_menus/version.rb
+- structured_menus.gemspec
+homepage: https://github.com/ArtOfCode-/structured_menus
+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.11
+signing_key: 
+specification_version: 4
+summary: An easy way to create flexible menus of things for Rails apps.
+test_files: []