cli-topic 0.9.1

data/lib/clitopic/topic/base.rb

@@ -0,0 +1,84 @@
+require 'set'
+require 'clitopic/topics'
+require 'clitopic/utils'
+
+module Clitopic
+  module Topic
+    class Base
+      attr_accessor :name, :description, :short_description, :hidden, :banner
+
+      def initialize(opts={}, force=false)
+        opts = {hidden: false}.merge(opts)
+        if !opts.has_key?(:name)
+          raise ArgumentError.new("missing Topic name")
+        end
+        @description = opts[:description]
+        @short_description = opts[:short_description]
+        @name = opts[:name]
+        @hidden = opts[:hidden]
+        @banner = opts[:banner]
+      end
+
+      def commands
+        @commands ||= {}
+      end
+
+
+      def short_description
+        if @short_description.nil?
+          if description
+            @short_description = description.split("\n").first
+          end
+        end
+        return @short_description
+      end
+
+      def name(arg=nil)
+        @name ||= arg
+      end
+
+      def description(arg=nil)
+        @description ||= arg
+      end
+
+      def hidden (arg=false)
+        @hidden ||= arg
+      end
+
+      def topic_options
+        self.class.topic_options
+      end
+
+      alias :hidden? :hidden
+
+      private
+
+      class << self
+        attr_accessor :instance
+        def option(name, *args, &blk)
+          opt = Clitopic::Utils.parse_option(name, *args, &blk)
+          if !opt[:default].nil?
+            options[name] = opt[:default]
+          end
+          topic_options << opt
+        end
+
+        def topic_options
+          @topic_options ||= []
+        end
+
+        def register(opts={}, force=false)
+          topic = self.new(opts, force)
+          if Topics[topic.name].nil? && force
+            raise TopicAlreadyExists.new ("Topic: #{topic.name} already exists: #{Topics[topic.name].class.name}")
+          else
+            if self.class != Clitopic::Topic::Base
+              @instance = topic
+            end
+            Topics[topic.name] = topic
+          end
+        end
+      end
+    end
+  end
+end

data/lib/clitopic/topic.rb

@@ -0,0 +1,4 @@
+require 'clitopic/topic/base'
+Dir[File.join(File.dirname(__FILE__), "topic", "*.rb")].each do |file|
+  require file
+end

data/lib/clitopic/topics.rb

@@ -0,0 +1,23 @@
+module Clitopic
+  class TopicAlreadyExists  < ArgumentError; end
+
+  class Topics
+    class << self
+      require 'clitopic/topic/base'
+      def []=(key, val)
+        if not (val.is_a?(Clitopic::Topic::Base))
+          raise ArgumentError.new("#{val} is not a Topic")
+        end
+        topics[key] = val
+      end
+
+      def [](key)
+        topics[key]
+      end
+
+      def topics
+        @@topics ||= {}
+      end
+    end
+  end
+end

data/lib/clitopic/utils.rb

@@ -0,0 +1,65 @@
+class String
+  def indent!(amount, indent_string=nil, indent_empty_lines=false)
+    indent_string = indent_string || self[/^[ \t]/] || ' '
+    re = indent_empty_lines ? /^/ : /^(?!$)/
+    gsub!(re, indent_string * amount)
+  end
+
+  def indent(amount, indent_string=nil, indent_empty_lines=false)
+    dup.tap {|_| _.indent!(amount, indent_string, indent_empty_lines)}
+  end
+
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+end
+
+module Clitopic
+  module Utils
+    class << self
+      def has_git?
+        %x{ git --version }
+        $?.success?
+      end
+
+      def git(args)
+        return "" unless has_git?
+        flattened_args = [args].flatten.compact.join(" ")
+        %x{ git #{flattened_args} 2>&1 }.strip
+      end
+
+      def retry_on_exception(*exceptions)
+        retry_count = 0
+        begin
+          yield
+        rescue *exceptions => ex
+          raise ex if retry_count >= 3
+          sleep 3
+          retry_count += 1
+          retry
+        end
+      end
+
+      def parse_option(name, *args, &blk)
+        # args.sort.reverse gives -l, --long order
+        default = nil
+        required = false
+        args.each do |a|
+          if a.is_a?(Hash)
+            if a.has_key?(:default)
+              default = a[:default]
+            end
+            if a.has_key?(:required)
+              required = a[:required]
+            end
+          end
+        end
+        return { :name => name, :args => args, default: default, required: required, :proc => blk }
+      end
+    end
+  end
+end

data/lib/clitopic/version.rb

@@ -0,0 +1,3 @@
+module Clitopic
+  VERSION = '0.9.1'
+end

data/lib/clitopic.rb

@@ -0,0 +1,44 @@
+require 'clitopic/version'
+require 'clitopic/parsers'
+
+module Clitopic
+  class << self
+    attr_accessor :debug, :commands_dir, :parser, :default_parser, :version, :default_files, :load_defaults, :name
+    def name
+      @name ||= 'clito'
+    end
+    def parser
+      @parser ||= default_parser
+    end
+
+    def load_defaults?
+      @load_defaults ||= true
+    end
+
+    def parser=(name)
+      Clitopic::Command::Base.extend name
+      @parser = name
+    end
+
+    def default_parser
+      @default_parsre ||= Clitopic::Parser::OptParser
+    end
+  end
+end
+
+
+# Defaults
+Clitopic.name = "clitopic"
+Clitopic.debug = false
+Clitopic.version = Clitopic::VERSION
+Clitopic.load_defaults = true
+Clitopic.default_files = [File.join(Dir.getwd, ".clitopic.yml"), File.join(Dir.home, ".clitopic.yml")]
+
+
+# Commaon Options
+
+# Clitopic::Commands.global_option(:v, "--version", "-v", "Show version") {puts Clitopic.version}
+
+Clitopic::Commands.global_option(:load_defaults, "--defaults-file FILE", "Load default variables") do |file|
+  Clitopic::Commands.current_cmd.load_defaults(file)
+end

data/spec/command_base_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Clitopic::Command::Base do
+
+  context 'register' do
+    context 'topic' do
+      it 'without topic should add command to global' do
+        expect(Clitopic::Commands.global_commands['root_cmd']).to eq RootCmd
+      end
+
+      it 'with topic name should add to existing topic' do
+        expect(Clitopic::Topics['a'].commands["cmd"]).to eq TopicaCmd
+        expect(Clitopic::Topics['a'].commands["index"]).to eq TopicaIndex
+      end
+
+      it 'with topic class should add to existing topic' do
+        expect(Clitopic::Topics['b'].commands["index"]).to eq TopicbIndex
+      end
+
+      it 'with topic attributes should create a topic then add cmd' do
+        expect(Clitopic::Topics['c'].commands["index"]).to eq TopiccIndex
+      end
+    end
+  end
+end

data/spec/commands_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Clitopic::Commands do
+
+  context 'Without topic' do
+    it 'should be include in global cmds' do
+      expect(Clitopic::Commands.global_commands['root_cmd']).to eq RootCmd
+    end
+
+    context ".prepare_run" do
+      it "should set @current_cmd" do
+        Clitopic::Commands.prepare_run("root_cmd")
+        expect(Clitopic::Commands.current_cmd).to eq RootCmd
+      end
+
+      it "@current_topic should be nil" do
+        Clitopic::Commands.prepare_run("root_cmd")
+        expect(Clitopic::Commands.current_topic).to be nil
+      end
+
+      it "should rescue to help cmd" do
+        Clitopic::Commands.prepare_run("unknowncmd")
+        expect(Clitopic::Commands.current_cmd).to eq 'help'
+      end
+    end
+  end
+
+  context 'With topic' do
+    context ".prepare_run" do
+      it "should set @current_cmd" do
+      Clitopic::Commands.prepare_run("a:cmd")
+        expect(Clitopic::Commands.current_cmd).to eq TopicaCmd
+      end
+
+      it "@current_topic should be the topic" do
+        Clitopic::Commands.prepare_run("a:cmd")
+        expect(Clitopic::Commands.current_topic).to be_a TopicA
+      end
+
+      it "should rescue to help cmd" do
+        Clitopic::Commands.prepare_run("unknowncmd:titi")
+        expect(Clitopic::Commands.current_cmd).to eq 'help'
+      end
+
+      it "should return index Cmd if no subcommand" do
+        Clitopic::Commands.prepare_run("a")
+        expect(Clitopic::Commands.current_cmd).to eq TopicaIndex
+      end
+
+    end
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,134 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec/'
+  add_group 'lib', 'lib'
+end
+
+require 'clitopic'
+class TopicA < Clitopic::Topic::Base
+  register name: "a",
+  description: "describe a"
+end
+
+class TopicB < Clitopic::Topic::Base
+  register name: "b",
+  description: "describe b"
+end
+
+class Topic < Clitopic::Topic::Base
+end
+
+class RootCmd < Clitopic::Command::Base
+  register name: 'root_cmd',
+  description: "descrption1",
+  banner: "banner1"
+end
+
+class TopicaCmd < Clitopic::Command::Base
+  register name: 'cmd',
+  description: "descrption_cmd",
+  banner: "banner_cmd",
+  topic: 'a'
+end
+
+class TopicaIndex < Clitopic::Command::Base
+  register name: 'index', topic: 'a'
+end
+
+class TopicbIndex < Clitopic::Command::Base
+  register name: 'index', topic: TopicB
+end
+
+class TopiccIndex < Clitopic::Command::Base
+  register name: 'index', topic: {name: 'c', description: 'topic c'}
+end
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/topic_base_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Clitopic::Topic::Base do
+
+  context 'register' do
+    it 'should add topic to Topics' do
+      expect(Clitopic::Topics['a']).to be_a  TopicA
+    end
+
+    it 'shoud Add instance to class' do
+      expect(Clitopic::Topics['a']).to eq TopicA.instance
+    end
+
+    it 'should failed if the name is already taken' do
+      expect {Topic.register(name: 'a', description: 'a bis')}.to raise_error Clitopic::TopicAlreadyExists
+    end
+
+    it 'should raise if no name is given' do
+      expect {Topic.register(description: 'a bis')}.to raise_error ArgumentError
+    end
+
+    it '.name should return name registred' do
+      expect(Clitopic::Topics['a'].name).to eq 'a'
+    end
+
+    it '.description should return description registred' do
+      expect(Clitopic::Topics['a'].description).to eq 'describe a'
+    end
+
+    it '.hidden should return hidden registred' do
+      expect(Clitopic::Topics['a'].hidden).to be false
+    end
+
+  end
+end

data/spec/topics_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Clitopic::Topics do
+
+  it "Topics[key] = topic should add the topic" do
+    topic = Clitopic::Topic::Base.new(name: 'new', description: 'desc')
+    Clitopic::Topics["c"] = topic
+    expect (Clitopic::Topics.topics['c']) == topic
+  end
+
+  it "Topics[key] = val should failed if it's not a Topic" do
+    expect {Clitopic::Topics["c"] = 3}.to raise_error ArgumentError
+  end
+
+  it ".topics should return the dict" do
+    expect(Clitopic::Topics.topics).to be_a Hash
+  end
+
+  it "Topics[key] should return the topic" do
+    expect(Clitopic::Topics['a']).to be_a  TopicA
+  end
+end

data/spec/utils_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe String do
+  context ".underscore" do
+    it "should snake_case string" do
+      expect('pipo'.underscore).to eq 'pipo'
+      expect('pi_po'.underscore).to eq 'pi_po'
+      expect('piPo'.underscore).to eq 'pi_po'
+      expect('PiPo'.underscore).to eq 'pi_po'
+      expect('PiPO'.underscore).to eq 'pi_po'
+      expect('PipO'.underscore).to eq 'pip_o'
+      expect('Pipo'.underscore).to eq 'pipo'
+    end
+
+  end
+
+end

data/spec/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Clitopic::VERSION do
+  it "should be equal 0.0.1" do
+    expect(Clitopic::VERSION).to eql("0.0.1")
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: cli-topic
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- Antoine Legrand
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: '["Small framework to build CLI organised in topics/subcommands.", "https://gitlab.com/ant31/cli-topics",
+  ["Antoine Legrand"]]'
+email:
+- ant.legrand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Changelog
+- License
+- README.md
+- lib/clitopic.rb
+- lib/clitopic/cli.rb
+- lib/clitopic/command.rb
+- lib/clitopic/command/base.rb
+- lib/clitopic/command/clito.rb
+- lib/clitopic/command/help.rb
+- lib/clitopic/command/version.rb
+- lib/clitopic/commands.rb
+- lib/clitopic/helpers.rb
+- lib/clitopic/parser/dummy.rb
+- lib/clitopic/parser/option_parser.rb
+- lib/clitopic/parsers.rb
+- lib/clitopic/topic.rb
+- lib/clitopic/topic/base.rb
+- lib/clitopic/topics.rb
+- lib/clitopic/utils.rb
+- lib/clitopic/version.rb
+- spec/command_base_spec.rb
+- spec/commands_spec.rb
+- spec/spec_helper.rb
+- spec/topic_base_spec.rb
+- spec/topics_spec.rb
+- spec/utils_spec.rb
+- spec/version_spec.rb
+homepage: https://gitlab.com/ant31/cli-topics
+licenses:
+- MIT
+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.5
+signing_key: 
+specification_version: 4
+summary: Small framework to build CLI.
+test_files:
+- spec/command_base_spec.rb
+- spec/commands_spec.rb
+- spec/spec_helper.rb
+- spec/topic_base_spec.rb
+- spec/topics_spec.rb
+- spec/utils_spec.rb
+- spec/version_spec.rb
+has_rdoc: