lucie-lib 0.0.1

data/Gemfile

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

data/Rakefile

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

data/lib/lucie/app.rb

@@ -0,0 +1,125 @@
+module Lucie
+  class App
+
+    attr_reader :command
+    attr_reader :root
+
+    def self.run(command = ARGV, root = nil)
+      obj = self.new(command, root)
+      obj.start
+      obj.exit_value
+    end
+
+    def initialize(command, root)
+      self.root = root || File.expand_path("..", File.dirname(Kernel.caller[2]))
+      self.command = command
+      @exit_value ||= 0
+      @task = nil
+    end
+
+    def start
+      help? ? call_help : call_method_invoking_process
+    end
+
+    def exit_value
+      @exit_value
+    end
+
+    class << self
+      attr_accessor :raise_exception
+      attr_accessor :log_level
+      @@raise_exception = false
+      @@log_level = :info
+    end
+
+private
+
+    def call_method_invoking_process
+      apply_validators
+      pair_parameters
+      call_action_on_controller
+    rescue => e
+      self.exception = e
+      give_user_friendly_error_message
+      write_backtrace
+      raise if self.class.raise_exception
+    end
+
+    def command=(value)
+      @command ||= CommandLineParser.new(value)
+    end
+
+    def help?
+      @command.has_option?("-h") || @command.has_option?("--help") || @command.has_arg?("help") || task == "help"
+    end
+
+    def task
+      @task ||= @command.shift
+    end
+
+    def action
+      @action ||= @command.shift
+      @action ? @action.to_sym : "index"
+    end
+
+    def controller
+      @controller ||= controller_class.send(:new, command)
+    end
+
+    def controller_class
+      @controller_class ||= [task.split("_").map{|i| i.capitalize}.join, "Controller"].join
+      Object.const_get(@controller_class.to_sym)
+    rescue NameError
+      include_controller_for(task)
+      Object.const_get(@controller_class.to_sym)
+    end
+
+    def include_controller_for(task)
+      require [root, "app/controllers", "#{task}_controller"].join("/")
+    rescue LoadError
+      self.exit_value = 255
+      raise ControllerNotFound, task
+    end
+
+    def call_action_on_controller
+      self.exit_value = controller.send(action || "index")
+    rescue NameError
+      self.exit_value = 255
+      raise ActionNotFound.new(action, task)
+    rescue Controller::ExitRequest => exit_request
+      self.exit_value = exit_request.code
+    end
+
+    def apply_validators
+      controller.class.apply_validators
+    end
+
+    def pair_parameters
+      controller.class.pair_parameters
+    end
+
+    def root=(value)
+      @root = value
+    end
+
+    def exception=(exception)
+      @exception = exception
+    end
+
+    def give_user_friendly_error_message
+      $stderr << @exception.to_s.strip
+    end
+
+    def write_backtrace
+      $stderr.puts Kernel.caller.join("\n") if App.log_level == :debug
+    end
+
+    def call_help
+      $stdout << controller.help
+    end
+
+    def exit_value=(exit_value)
+      @exit_value = exit_value if exit_value.is_a?(Fixnum)
+    end
+  end
+end

data/lib/lucie/command_line_parser.rb

@@ -0,0 +1,80 @@
+class CommandLineParser
+
+  attr_reader :options
+
+  def initialize(parameters)
+    @params_str = parameters.class == Array ? parameters.join(" ") : parameters
+    @options = {}
+    @latest_option = nil
+
+    parse_options()
+  end
+
+  def [](name)
+    @options[name]
+  end
+
+  def shift
+    @options[:args].shift
+  end
+
+  def pair(short, long)
+    short_p = remove_dashes(short).to_sym
+    long_p = remove_dashes(long).to_sym
+
+    if @options[short_p].class == String
+      @options[long_p] = @options[short_p]
+    else
+      @options[short_p] = @options[long_p]
+    end
+  end
+
+  def has_option?(option)
+    @options[remove_dashes(option).to_sym] || false
+  end
+
+  def has_arg?(option)
+    @options[:args].include?(option)
+  end
+
+private
+
+  def parse_options
+    array_of_options.each do |option|
+      if is_option?(option)
+        save_option(option)
+      else
+        save_parameter(option)
+      end
+    end
+  end
+
+  def is_option?(option)
+    option =~ /^-/
+  end
+
+  def remove_dashes(option)
+    option.gsub(/^-+/, "")
+  end
+
+  def save_option(option)
+    without_dashes = remove_dashes(option)
+    @options[without_dashes.to_sym] = true
+    @latest_option = without_dashes.to_sym
+  end
+
+  def save_parameter(option)
+    if @options[@latest_option].class == String
+      @options[@latest_option] += [" ", option].join
+    elsif !@latest_option
+      @options[:args] ||= []
+      @options[:args] << option
+    else
+      @options[@latest_option] = option
+    end
+  end
+
+  def array_of_options
+    @params_str.strip.split
+  end
+end

data/lib/lucie/controller/base.rb

@@ -0,0 +1,59 @@
+module Lucie
+  module Controller
+    class Base
+
+      include Validators::MandatoryOption
+      include Validators::Optional
+
+      class << self
+        @validators = []
+        @params = CommandLineParser.new("")
+      end
+
+      def initialize(command_line_parser)
+        self.class.params = command_line_parser
+      end
+
+      def self.params=(params)
+        @params = params
+      end
+
+      def params
+        self.class.params
+      end
+
+      def self.params
+        @params
+      end
+
+      def self.validators
+        @validators ||= []
+        @validators
+      end
+
+      def self.pair_parameters
+        validators.each do |validator|
+          short = validator.short_option
+          long  = validator.long_option
+
+          if short != "" && long != ""
+            params.pair(short, long)
+          end
+        end
+      end
+
+      def self.apply_validators
+        validators.each {|validator| validator.apply(params) } if validators
+      end
+
+      def exit(value)
+        raise ExitRequest, value
+      end
+
+      def help
+        "Help"
+      end
+
+    end
+  end
+end

data/lib/lucie/controller/exit_request.rb

@@ -0,0 +1,10 @@
+module Lucie
+  module Controller
+    class ExitRequest < Exception
+      attr_reader :code
+      def initialize(code)
+        @code = code
+      end
+    end
+  end
+end

data/lib/lucie/exceptions.rb

@@ -0,0 +1,27 @@
+module Lucie
+  class RequestError < StandardError
+    def initialize(validator)
+      super "#{validator.description} (#{validator.short_option}) is mandatory parameter"
+    end
+  end
+
+  class ControllerNotFound < StandardError
+    def initialize(controller_name)
+      super "Controller is not found for #{controller_name}."
+    end
+  end
+
+  class ActionNotFound < StandardError
+    def initialize(action, controller)
+      super "#{action} is not found in #{controller}."
+    end
+  end
+
+  class ExitRequest < Exception
+    attr_reader :exit
+    def initialize(exit)
+      @exit = exit
+    end
+  end
+
+end

data/lib/lucie/snippets/template.rb

@@ -0,0 +1,28 @@
+require 'erb'
+
+module Lucie
+  module Snippets
+    module Template
+      def create_file(file_path, &block)
+        dir_name = File.dirname(file_path)
+        if !File.directory?(dir_name)
+          FileUtils.mkdir_p(dir_name)
+        end
+
+        if block
+          File.open(file_path, "a") do |f|
+            yield(f)
+          end
+        else
+          File.new(file_path, "a")
+        end
+      end
+
+      def template(template, target)
+        create_file(target) do |f|
+          f.write ERB.new(File.read(template)).result(binding)
+        end
+      end
+    end
+  end
+end

data/lib/lucie/validators/base.rb

@@ -0,0 +1,25 @@
+module Lucie
+  module Validators
+    class Base
+      def initialize(*args)
+        @argname = args.flatten
+      end
+
+      def apply(params)
+        fail NotImplemented
+      end
+
+      def short_option
+        @argname.select{|option| option[0] == "-" && option[1] != "-"}.join.strip
+      end
+
+      def long_option
+        @argname.select{|option| option[0] == "-" && option[1] == "-"}.join.strip
+      end
+
+      def description
+        @argname.select{|option| option[0] != "-" }.first
+      end
+    end
+  end
+end

data/lib/lucie/validators/mandatory_option.rb

@@ -0,0 +1,27 @@
+module Lucie
+  module Validators
+    module MandatoryOption
+
+      class Validator < Base
+        def apply(params)
+          fail RequestError.new(self) unless params[:"#{short_option.gsub(/^-*/, '')}"]
+        end
+      end
+
+      def mandatory(*args)
+        v = Validator.new(args)
+        v.apply(params)
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def mandatory(*args)
+          self.validators << Validator.new(args)
+        end
+      end
+    end
+  end
+end

data/lib/lucie/validators/optional.rb

@@ -0,0 +1,21 @@
+module Lucie
+  module Validators
+    module Optional
+
+      class Validator < Base
+        def apply(params)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def optional(*args)
+          self.validators << Validator.new(args)
+        end
+      end
+    end
+  end
+end

data/lib/lucie/version.rb

@@ -0,0 +1,3 @@
+module Lucie
+  VERSION = "0.0.1"
+end

data/lib/lucie.rb

@@ -0,0 +1,28 @@
+require "lucie/version"
+require "lucie/exceptions"
+
+module Lucie
+
+  module Controller
+    autoload :ExitRequest, "lucie/controller/exit_request"
+  end
+
+  module Validators
+    autoload :MandatoryOption, "lucie/validators/mandatory_option"
+    autoload :Optional, "lucie/validators/optional"
+    autoload :Base, "lucie/validators/base"
+  end
+
+  module Snippets
+    autoload :Template, "lucie/snippets/template"
+  end
+
+  autoload :CommandLineParser, "lucie/command_line_parser"
+
+end
+
+require "lucie/app"
+require "lucie/controller/base"
+
+include Lucie
+

data/lucie-lib.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+version = File.read(File.expand_path('../../version', __FILE__)).strip
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "lucie-lib"
+  gem.version       = version
+  gem.authors       = ["Nucc"]
+  gem.email         = ["nucc@bteam.hu"]
+  gem.description   = %q{Command line utility framework}
+  gem.summary       = %q{}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "mini_shoulda"
+end

data/test/fixtures/command_parser_fixtures.rb

@@ -0,0 +1,55 @@
+class CommandParserController < Controller::Base
+  def hello
+    print "Hello World"
+  end
+
+  def hello_2
+    print params[:parameter]
+  end
+end
+
+class ParameterParser1Controller < Controller::Base
+  mandatory "-s", "Search expression"
+  def search
+    print "Ok"
+  end
+end
+
+class OptionalMandatoryController < Controller::Base
+  def search
+    mandatory "-s", "Search expression"
+    print "Ok"
+  end
+
+  def no_mandatory
+    print "Ok"
+  end
+end
+
+class ParameterPairingController < Controller::Base
+  optional "-e", "--expression", "Search expression"
+
+  def search_short
+    print params[:expression]
+  end
+
+  def search_long
+    print params[:e]
+  end
+end
+
+class ExitValueController < Controller::Base
+  def method1
+    exit 1
+  end
+
+  def no_exit
+    "asdf"
+  end
+end
+
+class CallIndexController < Controller::Base
+  def index
+    print "index_method"
+  end
+end

data/test/functional/command_parser_test.rb

@@ -0,0 +1,83 @@
+require "test_helper"
+require "stringio"
+require "helpers/test_app"
+require "fixtures/command_parser_fixtures"
+
+class CommandProcessorTest < MiniTest::Spec
+
+  should "parse commands" do
+    assert_output("Hello World", nil) { TestApp.run("command_parser hello") }
+  end
+
+  should "parse long parameter" do
+    assert_output("Parameter", nil) { TestApp.run("command_parser hello_2 --parameter Parameter") }
+  end
+
+
+  should "not give error when mandatory parameters are present" do
+    assert_output("Ok", nil) { TestApp.run("parameter_parser1 search -s") }
+  end
+
+  context "raise exception" do
+    setup do
+      TestApp.raise_exception = true
+    end
+
+    should "force mandatory parameters" do
+      assert_raises(Lucie::RequestError){ TestApp.run("parameter_parser1 search") }
+    end
+
+    should "give error, when method has mandatory parameter but another shouldn't throw in this case" do
+      assert_output("Ok", nil) { TestApp.run("optional_mandatory search -s") }
+      assert_raises(Lucie::RequestError){ TestApp.run("optional_mandatory search") }
+      assert_output("Ok", nil) { TestApp.run("optional_mandatory no_mandatory") }
+    end
+  end
+
+  should "be able to pair parameters" do
+    assert_output("some_string", nil) { TestApp.run("parameter_pairing search_short -e some_string") }
+    assert_output("some_string", nil) { TestApp.run("parameter_pairing search_long --expression some_string") }
+  end
+
+  should "write to stderr that no controller found when controller is missing" do
+    assert_output "", "Controller is not found for no_controller." do
+      TestApp.run("no_controller")
+    end
+  end
+
+  should "write to stderr that no action found when action is missing" do
+    assert_output "", "no_action is not found in optional_mandatory." do
+      TestApp.run("optional_mandatory no_action")
+    end
+  end
+
+  should "write user friendly message when mandatory parmaeter is missing" do
+    assert_output "", "Search expression (-s) is mandatory parameter" do
+      TestApp.run "parameter_parser1 search"
+    end
+  end
+
+  should "write help message for help command" do
+    assert_output "Help", "" do
+      TestApp.run "parameter_parser1 help"
+    end
+  end
+
+  should "return the exit value" do
+    assert_equal 1, TestApp.run("exit_value method1")
+  end
+
+  should "return 0 if exit value is missing" do
+    assert_equal 0, TestApp.run("exit_value no_exit")
+  end
+
+  should "return 255 when controller or action is missing" do
+    assert_equal 255, TestApp.run("no_controller_with_this_name")
+  end
+
+  should "call index method when only the task present" do
+    assert_output "index_method", "" do
+      TestApp.run("call_index")
+    end
+  end
+end

data/test/functional/template_snippet_test.rb

@@ -0,0 +1,84 @@
+require "test_helper"
+require "tempfile"
+
+class TemplateSnippetTest < MiniTest::Spec
+
+  include Snippets::Template
+
+  before do
+    @tmp_filename = template_path
+    remove_file(@tmp_filename) # if it exists
+  end
+
+  after do remove_file(@tmp_filename); end
+
+
+  describe "create_file" do
+
+    should "be able to create an empty file" do
+      create_file @tmp_filename
+      assert File.exists?(@tmp_filename)
+    end
+
+    should "be able to generate multi level directory if it doesn't exist" do
+      @tmp_filename = [template_dir, "a", "b", template_file_name].join("/")
+      create_file @tmp_filename
+      assert File.exists?(@tmp_filename)
+      FileUtils.rmtree([template_dir, "a"].join("/"))
+    end
+
+    should "be able to add content to a file using block" do
+      create_file @tmp_filename do |f|
+        f.puts "line_1"
+        f.puts "line_2"
+      end
+
+      lines = File.new(@tmp_filename, "r").read.split("\n")
+      assert_equal "line_1", lines[0]
+      assert_equal "line_2", lines[1]
+    end
+
+    should "be able to append content to a file" do
+      create_file @tmp_filename do |f| f.puts "line_1"; end
+      create_file @tmp_filename do |f| f.puts "line_2"; end
+
+      lines = File.new(@tmp_filename, "r").read.split("\n")
+      assert_equal "line_1", lines[0]
+      assert_equal "line_2", lines[1]
+    end
+  end
+
+  context "template" do
+    before do @template_file = Tempfile.new(template_file_name, template_dir); end
+
+    should "generate file from template using absolute directory" do
+      File.open(@template_file, "w+") do |f|
+        f.write "template <%= @variable %>"
+      end
+      @variable = "test_var_for_template"
+
+      template @template_file, @tmp_filename
+      assert_equal "template test_var_for_template", File.open(@tmp_filename, "r").read
+    end
+  end
+
+  private
+
+  def template_dir
+    File.expand_path("../../../tmp", __FILE__)
+  end
+
+  def template_file_name
+    rand = (Time.now.to_i * rand(10**6)).to_i
+    "template_#{rand}"
+  end
+
+  def template_path
+    [template_dir, template_file_name].join("/")
+  end
+
+  def remove_file(filename)
+    FileUtils.remove_file(filename) if File.exists?(filename)
+  end
+
+end

data/test/helpers/test_app.rb

@@ -0,0 +1,2 @@
+class TestApp < Lucie::App
+end

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+# MiniTest is integrated to Ruby library and by default the test wants to use that.
+# Force the Rubygems version
+require 'minitest/autorun'
+require "mini_shoulda"
+#require 'debugger'
+
+require File.expand_path('../../lib/lucie.rb', __FILE__)
+
+LUCIE_ROOT = File.expand_path File.dirname(__FILE__)
+
+class MiniTest::Spec
+  include Lucie
+
+  def setup
+    redirect_stderr
+  end
+
+  def teardown
+    reset_stderr_redirection
+  end
+
+  def redirect_stderr
+    @stderr = $stderr
+    $stderr = StringIO.new
+  end
+
+  def reset_stderr_redirection
+    $stderr = @stderr
+  end
+end

data/test/unit/command_line_parser_test.rb

@@ -0,0 +1,69 @@
+require "test_helper"
+
+class CommandLineParserTest < MiniTest::Spec
+
+  should "parse empty string" do
+    parser = CommandLineParser.new ""
+    assert_equal Hash.new, parser.options
+  end
+
+  should "parse short boolean value" do
+    parser = CommandLineParser.new "-a"
+    assert parser.options[:a]
+  end
+
+  should "parse more short boolean values" do
+    parser = CommandLineParser.new "-a -b"
+    assert parser.options[:a]
+    assert parser.options[:b]
+  end
+
+  should "parse long boolean value" do
+    parser = CommandLineParser.new "--long-parameter"
+    assert parser.options[:"long-parameter"]
+  end
+
+  should "parse multiple long boolean values" do
+    parser = CommandLineParser.new "--long-parameter --another-long-parameter"
+    assert parser.options[:"long-parameter"]
+    assert parser.options[:"another-long-parameter"]
+  end
+
+  should "parse string parameter" do
+    parser = CommandLineParser.new "--string this_is_a_string"
+    assert_equal "this_is_a_string", parser.options[:string]
+  end
+
+  should "parse more string parameters" do
+    parser = CommandLineParser.new "--string this is a string"
+    assert_equal "this is a string", parser.options[:string]
+  end
+
+  should "parse arguments" do
+    parser = CommandLineParser.new "arg1 arg2 -x -y"
+    assert_equal "arg1", parser.options[:args][0]
+    assert parser.options[:x]
+  end
+
+  should "be able to shift the args array" do
+    parser = CommandLineParser.new "arg1 arg2"
+    arg = parser.shift
+    assert_equal "arg1", arg
+    assert_equal "arg2", parser.options[:args][0]
+  end
+
+  should "be able to answer the an argument is present or not" do
+    parser = CommandLineParser.new "arg1 arg2"
+    assert parser.has_arg?("arg1")
+    assert parser.has_arg?("arg2")
+    assert !parser.has_arg?("arg3")
+  end
+
+  should "be able to answer the parameter is present or not" do
+    parser = CommandLineParser.new "arg1 -h -p"
+    assert parser.has_option?("h")
+    assert parser.has_option?("p")
+    assert !parser.has_option?("print")
+  end
+
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: lucie-lib
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nucc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mini_shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Command line utility framework
+email:
+- nucc@bteam.hu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- lib/lucie.rb
+- lib/lucie/app.rb
+- lib/lucie/command_line_parser.rb
+- lib/lucie/controller/base.rb
+- lib/lucie/controller/exit_request.rb
+- lib/lucie/exceptions.rb
+- lib/lucie/snippets/template.rb
+- lib/lucie/validators/base.rb
+- lib/lucie/validators/mandatory_option.rb
+- lib/lucie/validators/optional.rb
+- lib/lucie/version.rb
+- lucie-lib.gemspec
+- test/fixtures/command_parser_fixtures.rb
+- test/functional/command_parser_test.rb
+- test/functional/template_snippet_test.rb
+- test/helpers/test_app.rb
+- test/test_helper.rb
+- test/unit/command_line_parser_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2466274242132173745
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2466274242132173745
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- test/fixtures/command_parser_fixtures.rb
+- test/functional/command_parser_test.rb
+- test/functional/template_snippet_test.rb
+- test/helpers/test_app.rb
+- test/test_helper.rb
+- test/unit/command_line_parser_test.rb