hasmenu 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fb66574b326404756bf6aa1d3d4122047251d4c
+  data.tar.gz: f88fc0acd29c7f5b393bbbcc248705d44263e80f
+SHA512:
+  metadata.gz: 0be75e278d1345541d6cf8e2ad26e7faa77b7e34bff91354b7c1a8953e4fc5be5d2e381b296dcfa4040309cf28da864397768b84c0c15bd50cb0bd9071215d38
+  data.tar.gz: 397cefe3c973f82c51114468ce2355b35c4d066c0384155cefbab71d459cf1382f5fd0287fb4f79843e14ed00888b999efccdae9a0dfcfb356c143f4f0114a3b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1,55 @@
+AllCops:
+  Exclude:
+    - bin/**
+    - db/schema.rb
+    - db/settings.rb
+    - db/migrate/**
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: false
+
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 160
+
+Metrics/LineLength:
+  Max: 1500
+
+Metrics/MethodLength:
+  Max: 160
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: case
+  IndentOneStep: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/SymbolProc:
+  Enabled: false

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Samyukti
+
+MIT License
+
+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,52 @@
+# Has.Menu
+
+A utility to collect and process data for Has.Menu
+
+## Installation
+
+    $ gem install hasmenu
+
+## Usage
+
+### Spellcheck Menu
+
+You can spellcheck an individual file
+
+  hasmenu spellcheck <file>
+
+Or all the files in a directory
+
+  hasmenu spellcheck <directory>
+
+### Validate Files
+
+  hasmenu validate chains <chains-file>
+  hasmenu validate restaurants <restaurants-file>
+  hasmenu validate menu/chain <chain-menu>
+  hasmenu validate menu/restaurant <restaurant-menu>
+
+### Build Restaurant Menu
+
+You may build menus for all restaurants
+
+  hasmenu build all
+  hasmenu build chain <chain-uid>
+  hasmenu build restaurant <restaurant-uid>
+
+### Review Status & Reports
+
+Review the status and progress of the data collection
+
+  hasmenu report chains
+  hasmenu report restaurants
+  hasmenu report available
+  hasmenu report unavailable
+  hasmenu report approved
+  hasmenu report unapproved
+  hasmenu report progress
+  hasmenu report done
+  hasmenu report all
+
+## Notice
+
+This utility is published by Samyukti to enable collection of data for Has.Menu.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/hasmenu

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'hasmenu'
+
+trap "SIGINT" do
+  puts "\nExecution interrupted. Exiting.".colorize(:yellow)
+  exit 130
+end
+
+Hasmenu::Cli.start(ARGV)

data/hasmenu.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hasmenu/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hasmenu"
+  spec.version       = Hasmenu::VERSION
+  spec.authors       = ["Geordee Naliyath"]
+  spec.email         = ["geordee@gmail.com"]
+  spec.summary       = "A utility to collect and process data for Has.Menu"
+  spec.description   = "Has.Menu is an online service to discover restaurant menus. This utility is used internally to build and validate menu in YAML format."
+  spec.homepage      = "https://has.menu"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = %w(hasmenu)
+  # spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_dependency "colorize"
+  spec.add_dependency "json_schema"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/hasmenu.rb

@@ -0,0 +1,55 @@
+require "thor"
+require "hasmenu/version"
+require "hasmenu/printer"
+require "hasmenu/formatter"
+require "hasmenu/spellchecker"
+require "hasmenu/validator"
+require "hasmenu/builder"
+require "hasmenu/reporter"
+
+module Hasmenu
+  class Cli < Thor
+    map %w(--version -v) => :__print_version
+
+    desc "--version, -v", "Print the version"
+    def __print_version
+      puts Hasmenu::VERSION
+    end
+
+    desc "format <path>", "Format Has.Menu data"
+    option :location, aliases: :l, desc: "Path to data repository"
+    def format(path)
+      Hasmenu::Formatter.new(options).format(path)
+    end
+    map "f" => :format
+
+    desc "spellcheck <path>", "Run spellcheck on Has.Menu data"
+    option :dicts, aliases: :d, desc: "Path to dictionary files"
+    option :except, aliases: :e, desc: "Exception file id"
+    def spellcheck(path)
+      Hasmenu::SpellChecker.new(options).check(path)
+    end
+    map "sc" => :spellcheck
+
+    desc "validate <type> <path>", "Run validation on Has.Menu data"
+    option :schema, aliases: :s, desc: "Path to schema files"
+    def validate(type, path)
+      Hasmenu::Validator.new(type, options).perform(path)
+    end
+    map "v" => :validate
+
+    desc "build <type> [uid] [menu-uid]", "Build one or more restaurant menus from chain menu"
+    option :location, aliases: :l, desc: "Path to data repository"
+    def build(type, uid = nil, menu_uid = nil)
+      Hasmenu::Builder.new(type, options).build(uid, menu_uid)
+    end
+    map "b" => :build
+
+    desc "report <type>", "Report the status and metrics from the repository"
+    option :location, aliases: :l, desc: "Path to data repository"
+    def report(type)
+      Hasmenu::Reporter.new(type, options).report
+    end
+    map "r" => :report
+  end
+end

data/lib/hasmenu/builder.rb

@@ -0,0 +1,59 @@
+require "yaml"
+
+module Hasmenu
+  class Builder
+    include Printer
+
+    def initialize(type, options)
+      @type = type
+      @location = options[:location] || Dir.pwd
+    end
+
+    def build_menu(restaurant, menu_uid)
+      output = {}
+
+      output["restaurant"] = restaurant
+
+      chain   = restaurant["chain"]
+      menus   = menu_uid ? "#{menu_uid}.yml" : "*.yml"
+      pattern = File.join("#{@location}/menu/chain/#{chain}/#{menus}")
+
+      Dir.glob(pattern).each do |menu|
+        chain_menu = YAML.load_file(menu)
+        output["restaurant"]["menus"] = chain_menu["chain"]["menus"]
+
+        restaurant_dir = File.join(@location, "menu", "restaurant", restaurant["uid"])
+        FileUtils.mkdir_p(restaurant_dir) unless File.directory?(restaurant_dir)
+
+        menu_file = File.join(restaurant_dir, File.basename(menu))
+        File.open(menu_file, "w") { |f| f.write output.to_yaml }
+        print_build_for restaurant["uid"]
+      end
+    end
+
+    def build(uid, menu_uid)
+      restaurants_yml = "#{@location}/restaurants.yml"
+      unless File.exist? restaurants_yml
+        print_invalid_path
+        return
+      end
+      restaurants = YAML.load_file(restaurants_yml)
+
+      case @type
+        when "chain"
+          restaurants.select! { |r| r["chain"] == uid }
+        when "restaurant"
+          restaurants.select! { |r| r["uid"] == uid }
+        when "all"
+          restaurants
+        else
+          print_invalid_build
+      end
+
+      print_build_start
+      restaurants.each do |restaurant|
+        build_menu restaurant, menu_uid
+      end
+    end
+  end
+end

data/lib/hasmenu/formatter.rb

@@ -0,0 +1,41 @@
+require "yaml"
+
+module Hasmenu
+  class Formatter
+    include Printer
+
+    def initialize(options)
+      @location = options[:location] || Dir.pwd
+    end
+
+    def format_file(path)
+      file = YAML.load_file(path)
+      File.open(path, "w") { |f| f.write file.to_yaml }
+      print_format_for File.basename(File.dirname(path))
+    end
+
+    def format_files(path)
+      Dir.glob(path + "/**/*.yml") do |file|
+        format_file file
+      end
+    end
+
+    def format(path)
+      path = File.join(@location, path)
+
+      unless File.exist? path
+        print_invalid_path
+        return
+      end
+
+      print_format_start
+      if File.file?(path) && File.extname(path) == ".yml"
+        format_file path
+      elsif File.directory? path
+        format_files path
+      else
+        print_invalid_path
+      end
+    end
+  end
+end

data/lib/hasmenu/printer.rb

@@ -0,0 +1,56 @@
+require "colorize"
+
+module Hasmenu
+  module Printer
+    def print_header(title)
+      puts "--------------------------------------------------------------------------------".colorize(:green)
+      puts title.colorize(:green)
+      puts "--------------------------------------------------------------------------------".colorize(:green)
+    end
+
+    def print_invalid_path
+      puts "\n  error: please provide a valid file or directory\n".colorize(:red)
+    end
+
+    def print_format_start
+      puts "formatting files".colorize(:green)
+    end
+
+    def print_format_for(file)
+      puts "  - #{file}".colorize(:green)
+    end
+
+    def print_warn_repeats
+      puts "warning: please review the use of repeat property".colorize(:yellow)
+    end
+
+    def print_invalid_sequence
+      puts "#: failed name #: filename sequence should be a number for active, and xa for inactive menu"
+    end
+
+    def print_invalid_version
+      puts "#: failed name #: filename should match with menu uid and version"
+    end
+
+    def print_invalid_build
+      puts "\n  error: please provide a valid build type\n".colorize(:red)
+    end
+
+    def print_build_start
+      puts "building restaurant menus".colorize(:green)
+    end
+
+    def print_build_for(restaurant)
+      puts "  - #{restaurant}".colorize(:green)
+    end
+
+    def print_invalid_report
+      puts "\n  error: please provide a valid report type\n".colorize(:red)
+    end
+
+    def print_report(data)
+      data.each { |d| puts "  - #{d}".colorize(:green) }
+      print_header "Count: #{data.count}"
+    end
+  end
+end

data/lib/hasmenu/reporter.rb

@@ -0,0 +1,104 @@
+require "yaml"
+
+module Hasmenu
+  class Reporter
+    include Printer
+
+    def initialize(type, options)
+      @type = type
+      @location = options[:location] || Dir.pwd
+    end
+
+    def get_data(file, field)
+      data = YAML.load_file(file)
+      data.map { |e| e[field] }
+    end
+
+    def get_folder(files)
+      files.map { |f| File.basename(File.dirname(f)) }
+    end
+
+    def load_data
+      @yaml_chains       = get_data "chains.yml", "uid"
+      @yaml_restaurants  = get_data "restaurants.yml", "uid"
+      @restaurant_chains = get_data "restaurants.yml", "chain"
+      @file_chains       = get_folder Dir.glob("#{@location}/menu/chain/**/*.yml")
+      @file_restaurants  = get_folder Dir.glob("#{@location}/menu/restaurant/**/*.yml")
+    end
+
+    def report_chains
+      print_header "List of Chains"
+      print_report(@yaml_chains.sort)
+    end
+
+    def report_available
+      print_header "Available Chain Menus"
+      print_report(@file_chains.sort)
+    end
+
+    def report_unavailable
+      print_header "Unavailable Chain Menus"
+      print_report(@restaurant_chains.sort - @file_chains.sort)
+    end
+
+    def report_approved
+      print_header "Approved Restaurants"
+      print_report(@yaml_restaurants.sort)
+    end
+
+    def report_unapproved
+      print_header "Unapproved Chains"
+      print_report(@yaml_chains.sort - @restaurant_chains.sort)
+    end
+
+    def report_progress
+      print_header "Chain Menus in Progress"
+      print_report(@yaml_chains.sort - @file_chains.sort)
+    end
+
+    def report_done
+      print_header "Restaurant Menus Completed"
+      print_report(@file_restaurants.sort)
+    end
+
+    def report_all
+      report_chains
+      report_available
+      report_unavailable
+      report_approved
+      report_unapproved
+      report_progress
+      report_done
+    end
+
+    def report
+      unless File.exist? @location
+        print_invalid_path
+        return
+      end
+
+      return unless load_data
+
+      case @type
+        when "chains"
+          report_chains
+        when "available"
+          report_available
+        when "unavailable"
+          report_unavailable
+        when "approved", "restaurants"
+          report_approved
+        when "unapproved"
+          report_unapproved
+        when "progress"
+          report_progress
+        when "done"
+          report_done
+        when "all"
+          report_all
+        else
+          print_invalid_report
+      end
+    end
+  end
+end

data/lib/hasmenu/spellchecker.rb

@@ -0,0 +1,81 @@
+require "yaml"
+require "active_support"
+require "active_support/core_ext"
+require "active_support/inflector"
+
+# numeric test
+class String
+  def number?
+    true if Float(self) rescue false
+  end
+end
+
+module Hasmenu
+  class SpellChecker
+    include Printer
+
+    def initialize(options)
+      @dictd = options[:dicts] || File.join(Dir.pwd, ".meta", "dicts")
+      @xcept = options[:except]
+      @dicts = []
+    end
+
+    def load_dicts
+      yamls = Dir.glob("#{@dictd}/*.yml")
+      yamls.each do |yaml|
+        @dicts << YAML.load_file(yaml)
+      end
+    end
+
+    def values_of(h)
+      h.values.flatten.map do |e|
+        if e.is_a?(Hash)
+          values_of(e)
+        else
+          e.to_s.parameterize.split(/[^\w]/)
+        end
+      end
+    end
+
+    def spell_check(path)
+      xcept = @xcept || File.basename(File.dirname(path))
+      xyaml = File.join(@dictd, "excepts", xcept + ".yml")
+
+      if File.file? xyaml
+        except = YAML.load_file(xyaml)
+        @dicts << except
+      end
+
+      data = YAML.load_file(path)
+
+      diff = values_of(data).flatten.sort.uniq - @dicts.flatten
+      diff = diff.compact.delete_if(&:number?)
+
+      print_header path
+      puts diff if diff.present?
+    end
+
+    def spell_check_all(path)
+      Dir.glob(path + "/**/*.yml") do |file|
+        spell_check file
+      end
+    end
+
+    def check(path)
+      unless File.exist? path
+        print_invalid_path
+        return
+      end
+
+      load_dicts
+
+      if File.file? path
+        spell_check path
+      elsif File.directory? path
+        spell_check_all path
+      else
+        print_invalid_path
+      end
+    end
+  end
+end

data/lib/hasmenu/validator.rb

@@ -0,0 +1,121 @@
+require "yaml"
+require "json"
+require "json_schema"
+require "active_support"
+require "active_support/core_ext"
+
+module Hasmenu
+  class Validator
+    include Printer
+
+    def initialize(type, options)
+      @type = type.chomp("/")
+      @schemad = options[:schema] || File.join(Dir.pwd, ".meta", "schema")
+    end
+
+    def load_schema
+      file = File.join(@schemad, "#{@type}-v4.json")
+
+      if File.file? file
+        schema_data = JSON.parse File.read(file)
+        @schema, error = JsonSchema.parse(schema_data)
+        if error
+          puts error
+          return false
+        end
+        return true
+      else
+        print_invalid_path
+        return false
+      end
+    end
+
+    def validate_uniqueness(data)
+      schema_data = JSON.parse '{"type": "array", "items": {"type": "string"}, "uniqueItems": true}'
+      schema = JsonSchema.parse!(schema_data)
+
+      validated, errors = schema.validate(data)
+      unless validated
+        puts errors
+        duplicates = data.group_by { |e| e }.select { |k, v| v.size > 1 }.map(&:first)
+        puts JSON.dump duplicates
+      end
+    end
+
+    def validate(path)
+      print_header path
+
+      data = YAML.load_file(path)
+
+      # check valid schema
+      validated, errors = @schema.validate(data)
+      puts errors unless validated
+
+      # check unique columns
+      type, subtype = @type.split("/")
+      case type
+        when "chains", "restaurants"
+          validate_uniqueness(data.map { |x| x["uid"] })
+        when "menu"
+          case subtype
+            when "chain"
+              menus = data["chain"]["menus"] if data["chain"]
+            when "restaurant"
+              menus = data["restaurant"]["menus"] if data["restaurant"]
+          end
+      end
+
+      if menus
+        validate_uniqueness(menus.map { |m| m["uid"] })
+        menus.each do |menu|
+          sections = menu["sections"]
+          validate_uniqueness(sections.map { |s| s["uid"] })
+
+          items = sections.map { |s| s["items"].reject { |i| i["repeat"] } }.flatten
+          validate_uniqueness(items.map { |i| i["uid"] })
+          validate_uniqueness(items.map { |i| i["name"] })
+
+          print_warn_repeats \
+            if sections.map { |s| s["items"].select { |i| i["repeat"] } }.flatten.present?
+        end
+      end
+
+      # check file naming conventions
+      if menus
+        menu = menus.first
+        filename = File.basename(path, ".yml")
+        # sequence
+        if menu && menu.key?("active") && !menu["active"]
+          print_invalid_sequence unless filename[0..2] == "xa-"
+        else
+          print_invalid_sequence unless filename[0..2] =~ /[0-9][0-9]-/
+        end
+        # version
+        print_invalid_version unless filename[3..-1] == "#{menu['uid']}-v#{menu['version']}"
+      end
+    end
+
+    def validate_all(path)
+      Dir.glob(path + "/**/*.yml") do |file|
+        validate file
+      end
+    end
+
+    def perform(path)
+      unless File.exist? path
+        print_invalid_path
+        return
+      end
+
+      return unless load_schema
+
+      if File.file? path
+        validate path
+      elsif File.directory? path
+        validate_all path
+      else
+        print_invalid_path
+      end
+    end
+  end
+end

data/lib/hasmenu/version.rb

@@ -0,0 +1,3 @@
+module Hasmenu
+  VERSION = "0.1.4"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: hasmenu
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Geordee Naliyath
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Has.Menu is an online service to discover restaurant menus. This utility
+  is used internally to build and validate menu in YAML format.
+email:
+- geordee@gmail.com
+executables:
+- hasmenu
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/hasmenu
+- hasmenu.gemspec
+- lib/hasmenu.rb
+- lib/hasmenu/builder.rb
+- lib/hasmenu/formatter.rb
+- lib/hasmenu/printer.rb
+- lib/hasmenu/reporter.rb
+- lib/hasmenu/spellchecker.rb
+- lib/hasmenu/validator.rb
+- lib/hasmenu/version.rb
+homepage: https://has.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.2.2
+signing_key: 
+specification_version: 4
+summary: A utility to collect and process data for Has.Menu
+test_files: []