recommend-me 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 706c7fff69a6c1efa7419890d9ff3a2f42935129
+  data.tar.gz: 788922210696833e2d5126e178407ae80728421c
+SHA512:
+  metadata.gz: 67edffc23213bce9c3ccc3e13aef8288ae27374e2748c713974102205827c2bca6436d0f4126f2e38f7296f5cdfc319972b1f483720dbd13efb6bbbc77562ec4
+  data.tar.gz: 4bff3bf8b5952804d6e006b4ba788229d80a5a08964ac117fc2047a3a31a4ec5c39253407f53f520a17897c2f50de12464470246a46444cc6c73bff45a57bafe

data/README.md

@@ -0,0 +1,47 @@
+# Recommend-me
+
+Recommend-me gem is used to generate Dockerfile or Deployment.yml from a templates 
+
+## Installation
+
+You can install it by using a command:
+`gem install recommend-me`
+
+## Dependencies
+
+Cookbook Creator during its installation will also install required gems:
+* chef
+
+## Usage
+
+`recommend_me_generate <template> <options>`
+
+Where:
+* <template> is obligatory
+* <options> can be:
+  - `-p, --project <project_name>`
+  - `-l, --location <environment location : local or gce>`
+
+## Config options
+
+Config file could has following options:
+  - `project '<project_name>'`
+  - `location '<environment location : local or gce>'`
+
+## Config locations
+
+By default Recommend-me will search for config file in following places:
+* Under `env['RECOMMEND_ME_HOME']/recommend.rb` if set
+* Under `Current directory/recommend.rb`
+* Under `Current directory/.recommend/recommend.rb`
+* Under `$HOME/.recommend/recommend.rb`
+
+## Options merging
+
+Options will be merged in the following order:
+* Initially will be build hash with default options from CLI
+* CLI options will be overwritten by the options within config file
+* Config file options will be overwritten by any arguments which will be passed to the script
+
+*WARNING:* Recommend-me can have some bugs.
+Please report to serghei.anicheev@gmail.com if you will find any.

data/bin/recommend_me_generate

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+#
+# Copyright (c) 2016 Nemo AI, All Rights Reserved.
+#
+
+Kernel.trap(:INT) { print("\n"); exit 1 }
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+require 'recommend_me/main'
+
+RecommendMe::Main.new(ARGV.clone).run

data/lib/recommend_me/cli.rb

@@ -0,0 +1,44 @@
+#
+# Author:: Anicheev Serghei (<serghei.anicheev@gmail.com>)
+# Copyright:: Copyright (c) 2016 Nemo AI.
+#
+
+require 'mixlib/cli'
+
+module RecommendMe
+  class MCLI
+    include Mixlib::CLI
+
+    option :config_file,
+      :short => "-c config_file",
+      :long  => "--config",
+      :description => "The configuration file to use",
+      :default => ConfigLoader.new(nil, nil).config_location
+
+    option :project_name, 
+      :short => "-p project_name",
+      :long  => "--project-name",
+      :description => "Project name to use in templates",
+      :default => 'recommend-me'
+
+    option :location,
+      :short => "-l location",
+      :long => "--location",
+      :description => 'Location to use in a templates',
+      :default => 'local'
+
+    option :help,
+      :short => "-h",
+      :long => "--help",
+      :description => "Show this message",
+      :on => :tail,
+      :boolean => true,
+      :show_options => true,
+      :exit => 0
+
+    def run(argv=[])
+      parse_options(argv)
+    end
+
+  end
+end

data/lib/recommend_me/config.rb

@@ -0,0 +1,15 @@
+#
+# Author:: Anicheev Serghei (<serghei.anicheev@gmail.com>)
+# Copyright:: Copyright (c) 2016 Nemo AI.
+#
+
+require 'mixlib/config'
+
+module RecommendMe
+  class Config
+    extend Mixlib::Config
+      config_strict_mode true
+      configurable :project_name
+      configurable :location
+  end
+end

data/lib/recommend_me/config_loader.rb

@@ -0,0 +1,157 @@
+#
+# Author:: Anicheev Serghei (<serghei.anicheev@gmail.com>)
+# Copyright:: Copyright (c) 2016 Nemo AI.
+#
+# Initially this code block was developed by Chef community.
+# But in order to fit for our needs it was modified
+#
+
+
+require 'recommend_me/null_logger'
+require 'recommend_me/pathhelper'
+require 'pathname'
+
+module RecommendMe
+  class ConfigLoader
+
+    # Path to a config file requested by user, (e.g., via command line option). Can be nil
+    attr_accessor :explicit_config_file
+
+    def initialize(explicit_config_file, logger=nil)
+      @explicit_config_file = explicit_config_file
+      @recommend_config_dir = nil
+      @config_location = nil
+      @logger = logger || NullLogger.new
+    end
+
+    def no_config_found?
+      config_location.nil?
+    end
+
+    def config_location
+      @config_location ||= (explicit_config_file || locate_local_config)
+    end
+
+    def recommend_config_dir
+      if @recommend_config_dir.nil?
+        @recommend_config_dir = false
+        full_path = working_directory.split(File::SEPARATOR)
+        (full_path.length - 1).downto(0) do |i|
+          candidate_directory = File.join(full_path[0..i] + [".recommend"])
+          if File.exist?(candidate_directory) && File.directory?(candidate_directory)
+            @recommend_config_dir = candidate_directory
+            break
+          end
+        end
+      end
+      @recommend_config_dir
+    end
+
+    def load
+      # Ignore it if there's no explicit_config_file and can't find one at a
+      # default path.
+      return false if config_location.nil?
+
+      if explicit_config_file && !path_exists?(config_location)
+        raise "Specified config file #{config_location} does not exist"
+      end
+
+      # Have to set Config.config_file b/c other config is derived from it.
+      Config.config_file = config_location
+      read_config(IO.read(config_location), config_location)
+    end
+
+    # (Private API, public for test purposes)
+    def env
+      ENV
+    end
+
+    # (Private API, public for test purposes)
+    def path_exists?(path)
+      Pathname.new(path).expand_path.exist?
+    end
+
+    private
+
+    def have_config?(path)
+      if path_exists?(path)
+        logger.info("Using config at #{path}")
+        true
+      else
+        logger.debug("Config not found at #{path}, trying next option")
+        false
+      end
+    end
+
+    def locate_local_config
+      candidate_configs = []
+
+      # Look for $RECOMMEND_ME_HOME/recommend.rb (allow multiple recommend config on same machine)
+      if env['RECOMMEND_ME_HOME']
+        candidate_configs << File.join(env['RECOMMEND_ME_HOME'], 'recommend.rb')
+      end
+      # Look for $PWD/recommend.rb
+      if Dir.pwd
+        candidate_configs << File.join(Dir.pwd, 'recommend.rb')
+      end
+      # Look for $UPWARD/.recommend/recommend.rb
+      if recommend_config_dir
+        candidate_configs << File.join(recommend_config_dir, 'recommend.rb')
+      end
+      # Look for $HOME/.recommend/recommend.rb
+      PathHelper.home('.recommend') do |dot_recommend_dir|
+        candidate_configs << File.join(dot_recommend_dir, 'recommend.rb')
+      end
+
+      candidate_configs.find do | candidate_config |
+        have_config?(candidate_config)
+      end
+    end
+
+    def working_directory
+      Dir.pwd
+    end
+
+    def read_config(config_content, config_file_path)
+      Config.from_string(config_content, config_file_path)
+    rescue SignalException
+      raise
+    rescue SyntaxError => e
+      message = ""
+      message << "You have invalid ruby syntax in your config file #{config_file_path}\n\n"
+      message << "#{e.class.name}: #{e.message}\n"
+      if file_line = e.message[/#{Regexp.escape(config_file_path)}:[\d]+/]
+        line = file_line[/:([\d]+)$/, 1].to_i
+        message << highlight_config_error(config_file_path, line)
+      end
+      raise StandardError::ArgumentError, message
+    rescue Exception => e
+      message = "You have an error in your config file #{config_file_path}\n\n"
+      message << "#{e.class.name}: #{e.message}\n"
+      filtered_trace = e.backtrace.grep(/#{Regexp.escape(config_file_path)}/)
+      filtered_trace.each {|bt_line| message << "  " << bt_line << "\n" }
+      if !filtered_trace.empty?
+        line_nr = filtered_trace.first[/#{Regexp.escape(config_file_path)}:([\d]+)/, 1]
+        message << highlight_config_error(config_file_path, line_nr.to_i)
+      end
+      raise StandardError::ArgumentError, message
+    end
+
+
+    def highlight_config_error(file, line)
+      config_file_lines = []
+      IO.readlines(file).each_with_index {|l, i| config_file_lines << "#{(i + 1).to_s.rjust(3)}: #{l.chomp}"}
+      if line == 1
+        lines = config_file_lines[0..3]
+      else
+        lines = config_file_lines[Range.new(line - 2, line)]
+      end
+      "Relevant file content:\n" + lines.join("\n") + "\n"
+    end
+
+    def logger
+      @logger
+    end
+
+  end
+end

data/lib/recommend_me/generator.rb

@@ -0,0 +1,17 @@
+#
+# Author:: Anicheev Serghei (<serghei.anicheev@gmail.com>)
+# Copyright:: Copyright (c) 2016 Nemo AI.
+#
+
+require 'erb'
+
+module RecommendMe
+  class Generator
+    def self.generate_file(variables, template, file)
+      puts "CREATING FILE : #{file} FROM TEMPLATE : #{template}, USING VARIABLES : #{variables}\n"
+      template = Helpers.read_file(template)
+      data = ERB.new(template).result(binding)
+      Helpers.write_file(file, data)
+    end
+  end
+end

data/lib/recommend_me/helpers.rb

@@ -0,0 +1,35 @@
+#
+# Author:: Anicheev Serghei (<serghei.anicheev@gmail.com>)
+# Copyright:: Copyright (c) 2016 Nemo AI.
+#
+
+module RecommendMe
+  class Helpers
+
+    def self.load_config_file(default_options, modified_options)
+      config_file = default_options.merge!(modified_options)[:config_file]
+      File.exists?(config_file) ? config_file : raise_er
+    end
+
+    def raise_er
+      raise 'Selected config file does not exists or does not have read permissions'
+    end
+
+    def self.merge_configs(default_config, config, sym_hash)
+      combined_config = default_config.merge!(sym_hash)
+      combined_config_options = combined_config.merge(config)
+      config.replace(combined_config_options)
+    end
+
+    def self.read_file(path)
+      p "OPENING FILE : #{path} FOR READ\n"
+      ::File.open(path, 'r') { |f| f.read }
+    end
+
+    def self.write_file(path, data)
+      p "WRITING DATA : #{data} TO FILE : #{path}\n"
+      ::File.open(path, 'w') { |f| f.write(data) }
+    end
+
+  end
+end

data/lib/recommend_me/main.rb

@@ -0,0 +1,38 @@
+#
+# Author:: Anicheev Serghei (<serghei.anicheev@gmail.com>)
+# Copyright:: Copyright (c) 2016 Nemo AI.
+#
+
+require 'mixlib/cli'
+require 'mixlib/config'
+require 'recommend_me/config_loader'
+require 'recommend_me/cli'
+require 'recommend_me/helpers'
+require 'recommend_me/config'
+require 'recommend_me/generator'
+
+module RecommendMe
+  class Main
+
+    attr_reader :params
+
+    def initialize(argv=[])
+      @template = argv[0]
+      @params = argv
+      @file = argv[0].split('.erb').first
+    end  
+
+    def run
+      config_location = ConfigLoader.new(nil, nil).config_location
+      MCLI.use_separate_default_options true
+      cli = RecommendMe::MCLI.new
+      cli.run(@params)
+      generator_config = Helpers::load_config_file(cli.default_config, cli.config)
+      Config.from_file(generator_config)
+      sym_hash = Config.configuration.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      Helpers.merge_configs(cli.default_config, cli.config, sym_hash)
+      Generator.generate_file(cli.config, @template, @file)
+    end
+
+  end
+end

data/lib/recommend_me/null_logger.rb

@@ -0,0 +1,70 @@
+#
+# Author:: Daniel DeLeo (<dan@getchef.com>)
+# Copyright:: Copyright (c) 2014 Chef Software, Inc
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+  # Null logger implementation that just ignores everything. This is used by
+  # classes that are intended to be reused outside of Chef, but need to offer
+  # logging functionality when used by other Chef code.
+  #
+  # It does not define the full interface provided by Logger, just enough to be
+  # a reasonable duck type. In particular, methods setting the log level, log
+  # device, etc., are not implemented because any code calling those methods
+  # probably expected a real logger and not this "fake" one.
+  class NullLogger
+
+    def fatal(message, &block)
+    end
+
+    def error(message, &block)
+    end
+
+    def warn(message, &block)
+    end
+
+    def info(message, &block)
+    end
+
+    def debug(message, &block)
+    end
+
+    def add(severity, message=nil, progname=nil)
+    end
+
+    def <<(message)
+    end
+
+    def fatal?
+      false
+    end
+
+    def error?
+      false
+    end
+
+    def warn?
+      false
+    end
+
+    def info?
+      false
+    end
+
+    def debug?
+      false
+    end
+
+  end

data/lib/recommend_me/pathhelper.rb

@@ -0,0 +1,41 @@
+#
+# Author:: Anicheev Serghei (<serghei.anicheev@gmail.com>)
+# Copyright:: Copyright (c) 2016 Nemo AI.
+#
+# Initially this code block was developed by Chef community.
+# But in order to fit for our needs it was modified
+#
+
+class PathHelper
+    def self.home(*args)
+      @@home_dir ||= self.all_homes { |p| break p }
+      if @@home_dir
+        path = File.join(@@home_dir, *args)
+        block_given? ? (yield path) : path
+      end
+    end
+
+    def self.all_homes(*args)
+      paths = []
+      paths << Dir.home if ENV['HOME']
+
+      paths = paths.map { |home_path| home_path.gsub(path_separator, ::File::SEPARATOR) if home_path }
+
+      # Filter out duplicate paths and paths that don't exist.
+      valid_paths = paths.select { |home_path| home_path && Dir.exists?(home_path) }
+      valid_paths = valid_paths.uniq
+
+      # Join all optional path elements at the end.
+      # If a block is provided, invoke it - otherwise just return what we've got.
+      joined_paths = valid_paths.map { |home_path| File.join(home_path, *args) }
+      if block_given?
+        joined_paths.each { |p| yield p }
+      else
+        joined_paths
+      end
+    end
+
+    def self.path_separator
+        File::SEPARATOR
+    end
+end

data/recommend_me.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name        = 'recommend-me'
+  s.version     = '0.0.1'
+  s.date        = '2016-05-25'
+  s.summary     = 'Required to generate Dcokerfile or Deployment.yml'
+  s.description = 'This gem is used to generate Dcokerfile or Deployment.yml'
+  s.authors     = ['Serghei Anicheev']
+  s.email       = 'serghei.anicheev@gmail.com'
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 2.0.0'
+  s.bindir       = 'bin'
+  s.executables  = [ 'recommend_me_generate' ]
+  s.files = %w(README.md) + Dir.glob("*.gemspec") + Dir.glob("{lib,spec}/**/*", File::FNM_DOTMATCH).reject { |f|  File.directory?(f) }
+
+  s.add_dependency "chef-zero", "~> 4.4.0"
+ 
+  s.homepage    =
+    'http://rubygems.org/gems/recommend-me'
+  s.license       = 'Free License'
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: recommend-me
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Serghei Anicheev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef-zero
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.0
+description: This gem is used to generate Dcokerfile or Deployment.yml
+email: serghei.anicheev@gmail.com
+executables:
+- recommend_me_generate
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/recommend_me_generate
+- lib/recommend_me/cli.rb
+- lib/recommend_me/config.rb
+- lib/recommend_me/config_loader.rb
+- lib/recommend_me/generator.rb
+- lib/recommend_me/helpers.rb
+- lib/recommend_me/main.rb
+- lib/recommend_me/null_logger.rb
+- lib/recommend_me/pathhelper.rb
+- recommend_me.gemspec
+homepage: http://rubygems.org/gems/recommend-me
+licenses:
+- Free License
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Required to generate Dcokerfile or Deployment.yml
+test_files: []