lucie 0.0.1 → 0.0.2

data/README.md

@@ -1,8 +1,8 @@
-# Lucie
+# Lucie - Console Application Framework   [![Code Climate](https://api.travis-ci.org/Nucc/lucie.png)](https://travis-ci.org/Nucc/lucie) [![Code Climate](https://codeclimate.com/github/Nucc/lucie.png)](https://codeclimate.com/github/Nucc/lucie)
 
-The plan of this project is to create a framework for console applications. It would be a bit different to Thor, Rake, Getopt based command line frameworks, because it would based on MVC design pattern, where appears the controller layer to handle the command, the view to define templates for configuration files and the model to store data in XML or NoSQL database.
+The goal of this project is to create a framework for console applications. It would be a bit different to Thor, Rake, Getopt based command line frameworks, because it would based on MVC design pattern, where appears the controller layer to handle the command, the view to define templates for configuration files and the model to store data in XML or NoSQL database.
 
-Currently it's under hard developing.
+Currently it's under developing.
 
 Here is an example of dataflow:
 

metadata

@@ -1,116 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: lucie
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
+  prerelease: 
 platform: ruby
 authors:
 - Nucc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-18 00:00:00.000000000 Z
+date: 2013-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: lucie-bin
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 0.0.2
+  type: :runtime
   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
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mini_shoulda
-  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'
+        version: 0.0.2
 description: Command line utility framework
 email:
 - nucc@bteam.hu
-executables:
-- lucie
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
-- LICENSE.txt
 - README.md
-- Rakefile
-- bin/lucie
-- lib/lucie.rb
-- lib/lucie/app.rb
-- lib/lucie/buffer.rb
-- lib/lucie/command_line_parser.rb
-- lib/lucie/controller/base.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.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: ''
+homepage: http://my.luc.ie
 licenses: []
-metadata: {}
 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: -1758122624687308208
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1758122624687308208
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+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
+test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 10ef9f0d6a4569ca18cce0855f3a06a5f5d7d882
-  data.tar.gz: edb938079f4913b150e71d170f269ad2205ce672
-SHA512:
-  metadata.gz: de139e2b7d224bf25976b9af0fe64c005610f0ad6fc402471249136b6c840c6ce8a50d76fcf932bd6a8bff5a53aa4fbbfb721dfa5c071831003439caacbfd1e2
-  data.tar.gz: 14b3d6c99db863433ff0d82e723a0844d16b65a24f8d223fce4c69df182fdd16e95bee05d1ef734f03248eb7c2893b1d57c75cbc5e772e1e1a41156e9a5af1d6

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/Gemfile

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

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Nucc
-
-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/Rakefile

@@ -1,10 +0,0 @@
-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
-end
-task :default => :test

data/bin/lucie

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-Signal.trap("INT") { exit 1 }
-
-# Should not buffer stdout and strerr
-$stdout.sync = true
-$stderr.sync = true

data/lib/lucie.rb

@@ -1,25 +0,0 @@
-require "lucie/version"
-require "lucie/exceptions"
-
-module Lucie
-  module Controller
-    autoload :Base, "lucie/controller/base"
-  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 :App, "lucie/app"
-  autoload :Buffer, "lucie/buffer"
-  autoload :CommandLineParser, "lucie/command_line_parser"
-end
-
-include Lucie
-

data/lib/lucie/app.rb

@@ -1,60 +0,0 @@
-module Lucie
-  class App
-
-    attr_reader :command
-
-    def self.run(command = ARGV, root = nil)
-      self.new(command, root)
-    end
-
-    def initialize(command, root)
-      self.root = root || File.expand_path("..", File.dirname(Kernel.caller[2]))
-      self.command = command
-
-      controller.class.apply_validators
-      controller.class.pair_parameters
-      controller.send(action)
-      self
-    end
-
-    def root
-      @root
-    end
-
-    def output
-      controller.out.output
-    end
-
-private
-
-    def command=(value)
-      @command ||= value
-      @command = @command.split(" ") if @command.is_a? String
-    end
-
-    def task
-      @task ||= @command.shift
-    end
-
-    def action
-      @action ||= @command.shift.to_sym
-    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
-      require [root, "app/controllers", "#{task}_controller"].join("/")
-      Object.const_get(@controller_class.to_sym)
-    end
-
-    def root=(value)
-      @root = value
-    end
-
-  end
-end

data/lib/lucie/buffer.rb

@@ -1,14 +0,0 @@
-module Lucie
-  class Buffer
-
-    attr_reader :output
-
-    def initialize
-      @output = String.new
-    end
-
-    def <<(str)
-      @output += str.to_s
-    end
-  end
-end

data/lib/lucie/command_line_parser.rb

@@ -1,68 +0,0 @@
-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 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
-
-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)
-    remove_dashes(option)
-    @options[option.to_sym] = true
-    @latest_option = option.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

@@ -1,56 +0,0 @@
-module Lucie
-  module Controller
-    class Base
-
-      include Validators::MandatoryOption
-      include Validators::Optional
-
-      class << self
-        @validators = []
-        @params = CommandLineParser.new("")
-      end
-
-      def initialize(params)
-        self.class.params = CommandLineParser.new(params)
-      end
-
-      def out
-        @buffer ||= Buffer.new
-        @buffer
-      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
-
-    end
-  end
-end

data/lib/lucie/exceptions.rb

@@ -1,4 +0,0 @@
-module Lucie
-  class RequestError < StandardError
-  end
-end

data/lib/lucie/snippets/template.rb

@@ -1,28 +0,0 @@
-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

@@ -1,21 +0,0 @@
-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
-    end
-  end
-end

data/lib/lucie/validators/mandatory_option.rb

@@ -1,27 +0,0 @@
-module Lucie
-  module Validators
-    module MandatoryOption
-
-      class Validator < Base
-        def apply(params)
-          fail RequestError 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

@@ -1,21 +0,0 @@
-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

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

data/lucie.gemspec

@@ -1,23 +0,0 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'lucie/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = "lucie"
-  gem.version       = Lucie::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

@@ -1,39 +0,0 @@
-class CommandParserController < Controller::Base
-  def hello
-    out << "Hello World"
-  end
-
-  def hello_2
-    out << params[:parameter]
-  end
-end
-
-class ParameterParser1Controller < Controller::Base
-  mandatory "-s", "Search expression"
-  def search
-    out << "Ok"
-  end
-end
-
-class OptionalMandatoryController < Controller::Base
-  def search
-    mandatory "-s", "Search expression"
-    out << "Ok"
-  end
-
-  def no_mandatory
-    out << "Ok"
-  end
-end
-
-class ParameterPairingController < Controller::Base
-  optional "-e", "--expression", "Search expression"
-
-  def search_short
-    out << params[:expression]
-  end
-
-  def search_long
-    out << params[:e]
-  end
-end

data/test/functional/command_parser_test.rb

@@ -1,34 +0,0 @@
-require "test_helper.rb"
-require "helpers/test_app"
-require "fixtures/command_parser_fixtures"
-
-class CommandProcessorTest < MiniTest::Spec
-
-  should "parse commands" do
-    assert_equal "Hello World", TestApp.run("command_parser hello").output
-  end
-
-  should "parse long parameter" do
-    assert_equal "Parameter", TestApp.run("command_parser hello_2 --parameter Parameter").output
-  end
-
-  should "force mandatory parameters" do
-    assert_raises(Lucie::RequestError){ TestApp.run("parameter_parser1 search") }
-  end
-
-  should "not give error when mandatory parameters are present" do
-    assert_equal "Ok", TestApp.run("parameter_parser1 search -s").output
-  end
-
-  should "give error, when method has mandatory parameter but another shouldn't throw in this case" do
-    assert_equal "Ok", TestApp.run("optional_mandatory search -s").output
-    assert_raises(Lucie::RequestError){ TestApp.run("optional_mandatory search") }
-    assert_equal "Ok", TestApp.run("optional_mandatory no_mandatory").output
-  end
-
-  should "be able to pair parameters" do
-    assert_equal "some_string", TestApp.run("parameter_pairing search_short -e some_string").output
-    assert_equal "some_string", TestApp.run("parameter_pairing search_long --expression some_string").output
-  end
-
-end

data/test/functional/template_snippet_test.rb

@@ -1,84 +0,0 @@
-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

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

data/test/test_helper.rb

@@ -1,12 +0,0 @@
-# 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 File.expand_path('../../lib/lucie.rb', __FILE__)
-
-LUCIE_ROOT = File.expand_path File.dirname(__FILE__)
-
-class MiniTest::Spec
-  include Lucie
-end

data/test/unit/command_line_parser_test.rb

@@ -1,48 +0,0 @@
-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
-
-end