menu_txt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a47e229baae4fc5f271b96eba1150b75d23447ad
+  data.tar.gz: 204654922d6bb50738f99e46966dd41c9c330371
+SHA512:
+  metadata.gz: 53c42740e8d72bed5c330fb4ffdc598ba4f69f25b1f714ce57de81f64428be4425cf4ea6b1191eb9b40232d897b498d85b5d294cf3c5611b21eecabf36611820
+  data.tar.gz: 465707610456ada4dee7d199ac601aa9c7c3eeee7e9413656830c823be88551c12d3daee8c94b87078137a7ea9780bb4ae16322186b72daefae99a00802e1e09

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in menu_txt.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Maxim Chernyak
+
+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,123 @@
+# menu_txt
+
+If you have non-technical people who want to be able to edit menus on your website, this is the gem for you.
+
+## Usage
+
+The gem is not rails-dependent, but here's a good example of rails usage.
+
+Throw a text file somewhere, say `app/menus/my_awesome_menu.txt`.
+
+~~~plain
+1st level thing 1 | /foo1
+
+- 2nd level thing A | /foo1/bar1
+-- 3rd level thing A | /foo1/bar1/baz1
+-- 3rd level thing B | /foo1/bar1/baz2
+
+- 2nd level thing B | /foo1/bar2
+-- 3rd level thing A | /foo1/bar2/baz1
+
+- 2nd level thing C | /foo1/bar3
+
+1st level thing 2 | /foo2
+~~~
+
+You can place that file anywhere you like, but placing all the menus in one dir is a good idea, because we can add this line to `development.rb`.
+
+~~~ruby
+config.watchable_dirs['app/menus'] = [:txt]
+~~~
+
+This line ensures that all changes to txt files in `app/menus` will cause your rails app to reload, so you can see changes with a browser refresh.
+
+Next, create a class for your menu, for example it could be `app/models/my_awesome_menu.rb`. Put this code into it.
+
+~~~ruby
+MyAwesomeMenu = MenuTxt.parse_path('app/menus/my_awesome_menu.txt')
+~~~
+
+And now we just need a partial which will render itself recursively for every submenu. For example, let's create `app/views/my_awesome_menu/_nodes.html.erb`.
+
+~~~html
+<% nodes.each do |node| %>
+<li <%=raw node.leaf? ? '' : 'class="dropdown-submenu"' %>>
+  <%= link_to node.name, node.url %>
+
+  <% unless node.leaf? %>
+  <ul class="dropdown-menu">
+    <%= render 'my_awesome_menu/nodes', nodes: node.children %>
+  </ul>
+  <% end %>
+</li>
+<% end %>
+~~~
+
+Notice how I use `leaf?` above to determine if there are no more submenus under this node.
+
+Finally, wherever you want to render this menu in your html, all you gotta do is the following.
+
+~~~html
+<ul class="dropdown-menu">
+  <%= render 'my_awesome_menu/nodes', nodes: MyAwesomeMenu.children %>
+</ul>
+~~~
+
+So given you have css/javascript hooked to classes `dropdown-menu` and `dropdown-submenu`, everything would just work. Now try editing `my_awesome_menu.txt` and refreshing the page. That's it, now your marketing people could edit the a plain text file on github and commit it without your involvement.
+
+## Advanced usage
+
+### Traversing nodes
+
+The `MyAwesomeMenu` in the above example is fully `Enumerable` and if `each` is called without a block it returns a proper iterator. The order of iteration is exactly like reading the text file top to bottom.
+
+### Extending nodes
+
+If you want each node in your menu to have special methods, you can use your own node class. Simply create it kinda like this.
+
+~~~ruby
+class MySpecialMenuNode
+  include MenuTxt::Node
+
+  def highlight?
+    url.include?('special_deals')
+  end
+end
+~~~
+
+The `MenuTxt::Node` is a convenient module that gives you all the node boilerplate. Then, when you create the menu model, you can pass your node object as the second argument, and it will become root of the menu, which acts as the prototype for all nested nodes.
+
+~~~ruby
+MyAwesomeMenu =
+  MenuTxt.parse_path('app/menus/menu.txt', MySpecialMenuNode.new(nil))
+~~~
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'menu_txt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install menu_txt
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/maxim/menu_txt/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test_*.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "menu_txt"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/menu_txt.rb

@@ -0,0 +1,39 @@
+require 'menu_txt/version'
+require 'menu_txt/node'
+require 'menu_txt/simple_node'
+
+module MenuTxt
+  module_function
+
+  LINE_REGEXP = /\A(-*)\s*([^\|]+)\s*\|\s*(.+)\Z/.freeze
+  BLANK_REGEXP = /\A[[:space:]]*\z/.freeze
+
+  def parse_path(path, root = SimpleNode.new(nil))
+    File.open(path, 'r') { |file| parse(file, root) }
+  end
+
+  def parse(io, root = SimpleNode.new(nil))
+    current_node = root
+
+    io.each_line do |line|
+      next if BLANK_REGEXP === line
+      indent, name, url = line.match(LINE_REGEXP).captures.map(&:strip)
+      current_node_indent_size = current_node.level + 1
+
+      if (indent.size - current_node_indent_size) > 1
+        raise "Can only nest submenus 1 level at a time: (#{line})"
+      elsif indent.size > current_node_indent_size
+        current_node = current_node.children.last
+        current_node.add_child(name, url)
+      elsif indent.size < current_node_indent_size
+        unindents_count = current_node_indent_size - indent.size
+        unindents_count.times { current_node = current_node.parent }
+        current_node.add_child(name, url)
+      else
+        current_node.add_child(name, url)
+      end
+    end
+
+    root
+  end
+end

data/lib/menu_txt/node.rb

@@ -0,0 +1,46 @@
+module MenuTxt
+  module Node
+    include ::Enumerable
+
+    def initialize(name, url = '')
+      @name, @url, @parent, @children, @level = name, url, nil, [], -1
+    end
+
+    attr_reader :name, :url, :parent, :children, :level
+
+    def leaf?; children.empty? end
+
+    def traverse(&block)
+      if block_given?
+        yield(self) if parent
+
+        children.each do |child|
+          child.traverse(&block)
+        end
+      else
+        enum_for
+      end
+    end
+    alias_method :each, :traverse
+
+    def add_child(name, url)
+      self << self.class.new(name, url)
+    end
+
+    def <<(node)
+      node.parent = self
+      node.level = level + 1
+      children << node
+    end
+
+    protected
+
+    def level=(int)
+      @level = int
+    end
+
+    def parent=(node)
+      @parent = node
+    end
+  end
+end

data/lib/menu_txt/simple_node.rb

@@ -0,0 +1,7 @@
+require 'menu_txt/node'
+
+module MenuTxt
+  class SimpleNode
+    include MenuTxt::Node
+  end
+end

data/lib/menu_txt/version.rb

@@ -0,0 +1,3 @@
+module MenuTxt
+  VERSION = "0.1.0"
+end

data/menu_txt.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'menu_txt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "menu_txt"
+  spec.version       = MenuTxt::VERSION
+  spec.authors       = ["Maxim Chernyak"]
+  spec.email         = ["max@bitsonnet.com"]
+
+  spec.summary       = 'Build url menu trees in plain text with simple syntax.'
+  spec.homepage      = "https://github.com/maxim/menu_txt"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: menu_txt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maxim Chernyak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: pry
+  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'
+description: 
+email:
+- max@bitsonnet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/menu_txt.rb
+- lib/menu_txt/node.rb
+- lib/menu_txt/simple_node.rb
+- lib/menu_txt/version.rb
+- menu_txt.gemspec
+homepage: https://github.com/maxim/menu_txt
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Build url menu trees in plain text with simple syntax.
+test_files: []
+has_rdoc: