dracula 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ef4fdc18122746e01e3149d3fdbc21d262649f0
-  data.tar.gz: 0a2953b9331e1488dbb11955f1fc9a9ace65a767
+  metadata.gz: b6c602659c7e89af0bb4cbc3f0ec4a8a1a55c4b4
+  data.tar.gz: e34ed6c3b948eb8e26b258fad6dbd42ea93ec878
 SHA512:
-  metadata.gz: 560efe1eb189a1b04726345375797e277893f401a40dff95983ab6f29f31da8fb4710746018a42c3e4d10fd3006ee7751e5473bd4d2b2f1099d8b7d63bf7acb8
-  data.tar.gz: 84316707c0cee5f937493abc316a67f052b51140cb46430eb6631fed9a1394b3da24a3f3ccc07b799f0cb1731eaddf9b1053dcc948a24ed03101cee0e4cb102c
+  metadata.gz: a8a72ba7fc5a3dff0ddba48eb98bc572555582986ac0e17746b067eb87d013cbaab58c6ccb047d5b7911c20703b2a9efbdacaeb8fc8b480d276d074e90302cb0
+  data.tar.gz: 44c776e24136257cc0d299a852e6264ea7e77db1114bc9ab578768800253834ff08435b38aefbf0e18a1262150f630f392c6728250f74f1cdd4b7c2d6dc08454

data/README.md

@@ -1,27 +1,234 @@
-# Dracula
+# Dracula — CLI Framework
 
 [![Build Status](https://semaphoreci.com/api/v1/renderedtext/dracula/branches/master/badge.svg)](https://semaphoreci.com/renderedtext/dracula)
+[![Gem Version](https://badge.fury.io/rb/dracula.svg)](https://badge.fury.io/rb/dracula)
 
-## Usage
+Dracula is a framework for creating command line application.
 
-First, define your commands:
+The structure of the framework is heavily inspired by Thor, and can be even used
+as a drop in replacement for the Thor framework.
+
+Opposed to Thor, Dracula generates a Heroku like interface. For example, a task
+management app would have the following interface:
+
+``` txt
+app tasks:list
+app tasks:info
+app calendar:show
+app calendar:events:list
+app calendar:events:add
+```
+
+For help, you can always invoke:
+
+``` txt
+app help <command-name>
+```
+
+## Hello world example
 
 ``` ruby
-class Login < Dracula::Command
-  flag :username, :short => "u", :required => true
-  flag :password, :short => "p", :required => true
-  flag :verbose, :short => "v", :type => :boolean
-
-  def run
-    if flags[:vebose]
-      puts "Running verbosely"
-    end
+class CLI < Dracula
 
-    puts "Logginng in with #{flags[:username]}:#{flags[:password]}"
+  desc "hello", "displays hello messages"
+  def hello(message)
+    puts "Hi #{message}!"
   end
+
 end
+
+CLI.start(ARGV)
+```
+
+```
+$ cli hello dracula
+
+Hi dracula!
 ```
 
+Every method in your class represents a command.
+
+## Command line options
+
+A command can have one or more command line options.
+
 ``` ruby
-Login.run("--username Vlad --password Transylvania")
+class CLI < Dracula
+
+  option :name
+  desc "hello", "displays hello messages"
+  def hello
+    puts "Hi #{options[:name]}!"
+  end
+
+end
+
+CLI.start(ARGV)
+```
+
+```
+$ cli hello --name "Peter"
+
+Hi Peter!
+```
+
+The options are defined above the method.
+
+#### Default values
+
+Options can have default values:
+
+``` ruby
+class CLI < Dracula
+
+  option :name, :default => "there"
+  desc "hello", "displays hello messages"
+  def hello
+    puts "Hi #{options[:name]}!"
+  end
+
+end
+
+CLI.start(ARGV)
+```
+
+```
+$ cli hello
+
+Hi there!
+
+$ cli hello --name Peter
+
+Hi Peter!
+```
+
+#### Required options
+
+By default, every parameter is optional. You can pass set required to true to
+make the option compulsory.
+
+``` ruby
+class CLI < Dracula
+
+  option :name, :default => "there", :required => true
+  desc "hello", "displays hello messages"
+  def hello
+    puts "Hi #{options[:name]}!"
+  end
+
+end
+
+CLI.start(ARGV)
 ```
+
+```
+$ cli hello
+
+Missing option: --name NAME
+
+$ cli hello --name Peter
+
+Hi Peter!
+```
+
+#### Boolean options
+
+By default, the options expect a value to be passed. However, if you set the
+type of the option to boolean, only the flag need to be passed:
+
+``` ruby
+class CLI < Dracula
+
+  option :json, :type => :boolean
+  option :name, :required => true
+  desc "hello", "displays hello messages"
+  def hello
+    if options[:json]
+      puts '{ "message": "Hi #{options[:name]}!" }'
+    else
+      puts "Hi #{options[:name]}!"
+    end
+  end
+
+end
+
+CLI.start(ARGV)
+```
+
+```
+$ cli hello --name Peter
+
+Hi Peter!
+
+$ cli hello --name Peter --json
+
+{ "message": "Hi Peter!" }
+```
+
+## Namespaces
+
+A CLI application can have subcommands and subnamespaces. For example:
+
+``` ruby
+class Greetings < Dracula
+
+  desc "hello", "displays a hello message"
+  def hello
+    puts "Hi!"
+  end
+
+  desc "bye", "displays a bye message"
+  def bye
+    puts "Bye!"
+  end
+
+end
+
+class CLI < Dracula
+
+  desc "suck_blood", "suck blood from innocent victims"
+  def suck_blood
+    puts "BLOOD!"
+  end
+
+  subcommand "greetings", "shows various greetings", Greetings
+end
+
+CLI.start(ARGV)
+```
+
+```
+$ cli suck_blood
+BLOOD!
+
+$ cli greetings:hello
+Hi!
+
+$ cli greetings:bye
+Bye!
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file
+to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+<https://github.com/renderedtext/dracula>. This project is intended
+to be a safe, welcoming space for collaboration, and contributors are expected
+to adhere to the [Contributor Covenant](http://contributor-covenant.org) code
+of conduct.
+
+## License
+
+The gem is available as open source under the terms of
+the [MIT License](http://opensource.org/licenses/MIT).

data/lib/dracula/command.rb

@@ -22,9 +22,20 @@ class Dracula
       desc.name
     end
 
+    def arguments
+      @klass.instance_method(@method_name).parameters.select { |p| p[0] == :req }.map { |p| p[1].to_s.upcase }
+    end
+
+    def banner
+      namespace = @klass.namespace.name ? "#{@klass.namespace.name}:" : ""
+      args = arguments.count > 0 ? " #{arguments.join(" ")}" : ""
+
+      "#{namespace}#{desc.name}#{args}"
+    end
+
     def help
       msg = [
-        "Usage: #{Dracula.program_name} #{@klass.namespace.name ? "#{@klass.namespace.name}:" : "" }#{desc.name}",
+        "Usage: #{Dracula.program_name} #{banner}",
         "",
         "#{desc.description}",
         ""
@@ -46,19 +57,34 @@ class Dracula
     end
 
     def run(params)
-      args  = params.take_while { |p| p[0] != "-" }
-      flags = parse_flags(params.drop_while { |p| p[0] != "-" })
+      args = params.take_while { |p| p[0] != "-" }
 
-      missing_flags = missing_required_flags(flags)
+      if args.count != arguments.count
+        puts "Missing arguments"
+        puts ""
+        help
+        exit(1)
+      end
+
+      parsed_flags = parse_flags(params.drop_while { |p| p[0] != "-" })
 
-      if missing_flags.empty?
-        @klass.new(flags).public_send(method_name, *args)
-      else
-        puts "Required Parameter: --#{missing_flags.first.name}"
+      missing_flags = missing_required_flags(parsed_flags)
+
+      unless missing_flags.empty?
+        puts "Required Parameter: #{missing_flags.first.banner}"
         puts ""
         help
         exit(1)
       end
+
+      @klass.new(parsed_flags).public_send(method_name, *args)
+    rescue OptionParser::MissingArgument => ex
+      flag = flags.find { |f| "--#{f.name}" == ex.args.first }
+
+      puts "Parameter has no value: #{flag.banner}"
+      puts ""
+      help
+      exit(1)
     end
 
     private

data/lib/dracula/flag.rb

@@ -32,10 +32,28 @@ class Dracula
     alias_method :short_name, :alias_name
 
     def banner
-      if alias_name.nil?
+      if short_name_banner
+        "#{short_name_banner}, #{long_name_banner}"
+      else
+        long_name_banner
+      end
+    end
+
+    def short_name_banner
+      return nil if short_name.nil?
+
+      if boolean?
+        "-#{short_name}"
+      else
+        "-#{short_name} #{name.upcase}"
+      end
+    end
+
+    def long_name_banner
+      if boolean?
         "--#{name}"
       else
-        "-#{alias_name}, --#{name}"
+        "--#{name} #{name.upcase}"
       end
     end
 

data/lib/dracula/version.rb

@@ -1,3 +1,3 @@
 class Dracula
-  VERSION = "0.2.0".freeze
+  VERSION = "0.2.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dracula
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Igor Šarčević
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-21 00:00:00.000000000 Z
+date: 2017-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler