cliqr 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64c9b1b3318e0cd2646101dbfc3cb974cd1d891d
-  data.tar.gz: b4a65fe6d1b0140db0ea977f7451fedb6940c0e3
+  metadata.gz: 79c47830a838dbb29465c407eab7a17226ba1999
+  data.tar.gz: 7194f0d76b8f37fba854fbeae463e4ffd7cb1053
 SHA512:
-  metadata.gz: 98f2dc57afa45411eefb719490b7f093ac8f257e4489a76f1954fcacd63d81f1578d20133558dcc0b812c78c09b986224f9226cfd26dbca18ad5e88a14b6b6a8
-  data.tar.gz: 143079da7b58f455e98c15c7d65524005f8190455464a0861c87aaac4aa3966f14d1dd9d1771009d48c426ed9b97dea1cc7ef6d4da1fdb71c975b8670efcb181
+  metadata.gz: 14d192c7b142d1cf0183466b118c4a7090de49698c0aa8c2e99bbda36e7adba1cc1ea32ffd1a792a2c14133af73b2dc62425f66099d07a5c21f5515864b62cae
+  data.tar.gz: df85568578f3aedd565a82c6ba9e5a25fb3d2747d877dc8cc096bec11f435ab85834b08c430dd89de0501de55a7bfa6ad08ffd39cb0effc0dff46b6888ec81ff

data/CHANGELOG.md

@@ -1,4 +1,32 @@
 
+0.0.2 / 2015-05-07
+==================
+
+  * add rake cleanup task
+  * adding rdoc rake task
+  * adding yard for checking documentation coverage
+  * use shields.io badges
+  * fix readme toc
+  * add codeclimate and coveralls badges to readme
+  * add coveralls for code coverage reporting
+  * load source code after starting codeclimate reporter
+  * add codeclimate code coverage report
+  * adding example to readme
+  * add travis CI build badge
+  * add build matrix to travis CI settings
+  * set ruby gem name
+  * set ruby version
+  * list files to document
+  * fix rake default task
+  * bring down bundler version to 1.6 for travis CI
+  * adding missing comment in version.rb
+  * enabling Travis CI build
+  * add test to test for non-nil config
+  * separate dsl methods in config class
+  * ignore auto-generated documentation
+  * add ability to provide a name for top level command
+  * adding gem badge to readme
+
 0.0.1 / 2015-04-29
 ==================
 

data/README.md

@@ -1,12 +1,20 @@
-# Cliqr
+# cliqr
+
+[![Build](http://img.shields.io/travis-ci/anshulverma/cliqr.svg?style=flat-square)](https://travis-ci.org/anshulverma/cliqr)
+[![Coverage](http://img.shields.io/codeclimate/coverage/github/anshulverma/cliqr.svg?style=flat-square)](https://codeclimate.com/github/anshulverma/cliqr)
+[![Quality](http://img.shields.io/codeclimate/github/anshulverma/cliqr.svg?style=flat-square)](https://codeclimate.com/github/anshulverma/cliqr)
+[![Dependencies](http://img.shields.io/gemnasium/anshulverma/cliqr.svg?style=flat-square)](https://gemnasium.com/anshulverma/cliqr)
+[![Downloads](http://img.shields.io/gem/dtv/cliqr.svg?style=flat-square)](https://rubygems.org/gems/cliqr)
+[![Version](http://img.shields.io/gem/v/cliqr.svg?style=flat-square)](https://rubygems.org/gems/cliqr)
 
 <!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
 **Table of Contents**
 
-- [Cliqr](#cliqr)
+- [cliqr](#cliqr)
     - [Summary](#summary)
+    - [Examples](#examples)
+        - [Simple CLI app with basename and description](#simple-cli-app-with-basename-and-description)
     - [Installation](#installation)
-    - [Usage](#usage)
     - [Contributing](#contributing)
 
 <!-- markdown-toc end -->
@@ -14,7 +22,35 @@
 
 ## Summary
 
-TODO: Write a gem description
+`cliqr` is a lightweight framework and DSL to easily build a command
+line application. Features include:
+
+- Command Routing
+- DSL for simple interface definition
+- Usage info generation
+- Error handling
+
+## Examples
+
+The DSL provides several helper methods to build interfaces of different
+styles. Here are some examples.
+
+### Simple CLI app with basename and description
+
+Here is a simple hello-world example for using Cliqr.
+
+``` ruby
+cli = Cliqr.interface do
+  basename 'my-command'
+end
+puts cli.usage
+```
+
+This should print
+
+```
+USAGE: my-command
+```
 
 ## Installation
 
@@ -32,10 +68,6 @@ Or install it yourself as:
 
     $ gem install cliqr
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Contributing
 
 1. Fork it ( https://github.com/anshulverma/cliqr/fork )

data/Rakefile

@@ -1,2 +1,27 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rake/clean'
 
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+FileList['tasks/*.rake'].each(&method(:import))
+
+desc 'default rake task'
+task default: [:clean, :spec, :verify_measurements, :yardstick_measure]
+
+desc 'run CI tasks'
+task ci: [:default]
+
+desc 'Load gem inside irb console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require File.join(__FILE__, '../lib/cliqr')
+  ARGV.clear
+  IRB.start
+end
+
+# temporary files for cleanup
+CLEAN.include('coverage')

data/lib/cliqr.rb

@@ -1,6 +1,21 @@
 require 'cliqr/version'
-require 'cliqr/dsl/cli'
+require 'cliqr/error'
 
+require 'cliqr/cli/config'
+require 'cliqr/cli/builder'
+
+# Top level namespace for the Cliqr gem
 module Cliqr
-  # Your code goes here...
+  class << self
+    # Invokes the CLI::Config builder DSL to prepare config for command line
+    # application. Then uses that config to build a instance of type Cliqr::CLI
+    #
+    # @return [Cliqr::CLI]
+    #
+    # @api public
+    def interface(&block)
+      config = CLI::Config.build(&block)
+      CLI::Builder.new(config)
+    end
+  end
 end

data/lib/cliqr/cli/builder.rb

@@ -0,0 +1,31 @@
+require 'cliqr/cli/validator'
+
+module Cliqr
+  module CLI
+    # Builds usage information from [CLI::Config]
+    class Builder
+      # Start building a command line interface
+      #
+      # @param [Hash] config
+      #   the configuration options for the interface (validated using
+      #   CLI::Validator)
+      #
+      # @return [Cliqr::CLI::Builder]
+      def initialize(config)
+        CLI::Validator.validate config
+        @basename = config[:basename]
+      end
+
+      # Get usage information of this command line interface instance
+      #
+      # @return [String]
+      #
+      # @api public
+      def usage
+        <<-EOS
+USAGE: #{@basename}
+EOS
+      end
+    end
+  end
+end

data/lib/cliqr/cli/config.rb

@@ -0,0 +1,47 @@
+require 'cliqr/dsl'
+
+module Cliqr
+  module CLI
+    # The configuration setting to build a cli application with its own dsl
+    class Config
+      extend Cliqr::DSL
+
+      def initialize
+        @config = {}
+      end
+
+      # Set value for a config option
+      #
+      # @param name
+      #   name of the config parameter
+      #
+      # @param value
+      #   value for the config parameter
+      #
+      # @return [String] value that was set for the parameter
+      def set_config(name, value)
+        @config[name.to_sym] = value
+      end
+
+      # Finalize config by adding default values for unset values.
+      #
+      # @return [Hash]
+      def finalize
+        {
+          basename: ''
+        }.merge(@config)
+      end
+
+      # dsl methods
+      dsl do
+        # Set basename for the command line interface
+        #
+        # @param [String] basename
+        #   name of the top level command
+        def basename(basename)
+          set_config :basename, basename
+        end
+      end
+    end
+  end
+end

data/lib/cliqr/cli/validator.rb

@@ -0,0 +1,12 @@
+require 'cliqr/error'
+
+module Cliqr
+  module CLI
+    # Validator for the command line interface configuration
+    class Validator
+      def self.validate(config)
+        fail Cliqr::Error::ConfigNotFound, 'config is nil' if config.nil?
+      end
+    end
+  end
+end

data/lib/cliqr/dsl.rb

@@ -0,0 +1,59 @@
+require 'delegate'
+
+module Cliqr
+  # Used to separate all dsl methods in a separate block, thus allowing
+  # separation of concerns between non-dsl methods with dsl methods which
+  # improves maintainability.
+  module DSL
+    # Entry point for invoking dsl methods
+    #
+    # @param args Arguments to be used to build the DSL instance
+    #
+    # @param block The block to evaluate the DSL
+    #
+    # @return [Cliqr::DSL]
+    def build(*args, &block)
+      base = new(*args)
+      if block_given?
+        delegator_klass = const_get('DSLDelegator')
+        delegator = delegator_klass.new(base)
+        delegator.instance_eval(&block)
+      end
+      base.finalize
+    end
+
+    # Delegates all DSL methods to the base class. Can be used to keep DSL
+    # methods separate from non-dsl methods.
+    #
+    # @param block Block containing all dsl methods
+    #
+    # Allows separating dsl methods as:
+    #
+    #     class MyDSLClass
+    #       extends Cliqr::DSL
+    #
+    #       def set_value(value)
+    #         @value = value
+    #       end
+    #
+    #       # ... other non-dsl methods ...
+    #
+    #       dsl do
+    #         def value(value)
+    #           set_value value
+    #         end
+    #       end
+    #
+    #     end
+    #
+    # This will be invoked as:
+    #
+    #    MyDSLClass.build do
+    #      value 'some-value'
+    #    end
+    def dsl(&block)
+      delegator_klass = Class.new(SimpleDelegator, &block)
+      const_set('DSLDelegator', delegator_klass)
+    end
+  end
+end

data/lib/cliqr/error.rb

@@ -0,0 +1,5 @@
+module Cliqr
+  module Error
+    class ConfigNotFound < StandardError; end
+  end
+end

data/lib/cliqr/version.rb

@@ -1,3 +1,4 @@
+# Versioned gem
 module Cliqr
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/dsl/interface_builder_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Cliqr::CLI::Builder do
+  it 'does not allow empty config' do
+    expect { Cliqr::CLI::Builder.new(nil) }.to raise_error(Cliqr::Error::ConfigNotFound)
+  end
+end

data/spec/dsl/interface_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Cliqr do
+  it 'builds a base command with name' do
+    cli = Cliqr.interface do
+      basename 'tinbox'
+    end
+
+    expect(cli.usage).to eq <<-EOS
+USAGE: tinbox
+EOS
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,14 @@
+# enable code climate
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.configure do |config|
+  config.logger.level = Logger::WARN
+end
+CodeClimate::TestReporter.start
+
+# enable coveralls
+require 'coveralls'
+Coveralls.wear!
+
 require 'bundler/setup'
 Bundler.setup
 
@@ -5,7 +16,6 @@ require 'cliqr'
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end

metadata

@@ -1,71 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: cliqr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Anshul Verma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-30 00:00:00.000000000 Z
+date: 2015-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log4r
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.6'
   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'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '1.6'
 description: |2
                             Allows you to easily define the interface for a CLI app
                             using an easy to use DSL.
@@ -78,19 +50,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".projectile"
-- ".rspec"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- cliqr.gemspec
 - lib/cliqr.rb
-- lib/cliqr/dsl/cli.rb
+- lib/cliqr/cli/builder.rb
+- lib/cliqr/cli/config.rb
+- lib/cliqr/cli/validator.rb
+- lib/cliqr/dsl.rb
+- lib/cliqr/error.rb
 - lib/cliqr/version.rb
-- spec/dsl/subcommand_spec.rb
+- spec/dsl/interface_builder_spec.rb
+- spec/dsl/interface_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/anshulverma/cliqr
 licenses:
@@ -102,20 +74,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A framework and DSL for defining CLI interface
 test_files:
-- spec/dsl/subcommand_spec.rb
+- spec/dsl/interface_builder_spec.rb
+- spec/dsl/interface_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/.gitignore

@@ -1,16 +0,0 @@
-# Temporary files
-*~
-*#*
-
-# Log files
-*.log
-
-# IDEA
-.idea/
-*.iml
-*.ipr
-*.iws
-
-# Ruby gem
-*.gem
-Gemfile.lock

data/.projectile

@@ -1,19 +0,0 @@
-# SCM
--.git/
-
-# Temporary files
-*~
-*#*
-
-# Log files
-*.log
-
-# Ruby gem
-*.gem
-Gemfile.lock
-
-# IDEA
-.idea/
-*.iml
-*.ipr
-*.iws

data/.rspec

@@ -1,3 +0,0 @@
---color
---require spec_helper
---format documentation

data/Gemfile

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

data/cliqr.gemspec

@@ -1,40 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cliqr/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'cliqr'
-  spec.version       = Cliqr::VERSION
-  spec.authors       = ['Anshul Verma']
-  spec.email         = ['ansverma@adobe.com']
-  spec.summary       = %q{A framework and DSL for defining CLI interface}
-  spec.homepage      = 'https://github.com/anshulverma/cliqr'
-  spec.description   = <<-EOS
-                          Allows you to easily define the interface for a CLI app
-                          using an easy to use DSL.
-
-                          Includes a lightweight framework for a CLI app.
-                          Features: command routing, error handling, usage generation...more to come
-                       EOS
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-
-  spec.required_ruby_version     = '>= 1.9.3'
-  spec.required_rubygems_version = '>= 1.3.6'
-
-  # runtime dependencies
-  {
-      :log4r => '~> 1.1'
-  }.each { |dependency, version| spec.add_runtime_dependency dependency.to_s, version }
-
-  # development dependencies
-  {
-      :bundler => '~> 1.7',
-      :rake => '~> 10.0',
-      :rspec => '~> 3.2'
-  }.each { |dependency, version| spec.add_development_dependency dependency.to_s, version }
-end

data/lib/cliqr/dsl/cli.rb

@@ -1,7 +0,0 @@
-module Cliqr
-  module DSL
-    class CLI
-
-    end
-  end
-end

data/spec/dsl/subcommand_spec.rb

@@ -1,8 +0,0 @@
-require 'spec_helper'
-
-
-describe Cliqr::DSL do
-  it 'executes dummy test' do
-    expect(1).to eq 1
-  end
-end