hanami-cli 0.3.1 → 1.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60885ef66fb058be469d4eedc0d6bb7d87313cd41fd07e901b931ae4843fde94
-  data.tar.gz: 0f94f42aa87986edaf8b9664b09f9cdc0fa301a68c27ce8b6b75672db6201883
+  metadata.gz: 0fe57714d6c897c21dd896eac31b8075fc52a7d747a2b9d7745bddebc4233818
+  data.tar.gz: 76217ba7ae795a50d4c37c92f837d826f009b178cf8f2d169985cfde35abff8f
 SHA512:
-  metadata.gz: fd337cf63a535c96d76bcd156947542484a8c5f6a7a5d36c305c9e5b780ebbcc2fa150ee82eacb0c039805ac8d3b13ef05eaf5addba81481e4da9a0e39210fae
-  data.tar.gz: febc46f538af4d8d2a0676f97be14e4571a3e407345a07a84a748dd877a4753b5ddd2713be866e7b294eddfa0a79ef20e39b308138fc5626108f46ae5d9aff24
+  metadata.gz: 3e61b952023ef34ce48c2c24a3108e3b9087c7712e961a4af0c6eaee42aa707f661aba35f733468aec27ee02924578c9e65a12f499fc5a00e288666561c584fb
+  data.tar.gz: 9d04ca91f9372567f72d852222e82caf639019df436c9c58b31fd828ad841ec3b75f93bdce08c585ac55345e71478c27f05cf4b88fdf8e3e88ba50bcbfcdd279

data/.circleci/config.yml

@@ -4,56 +4,6 @@
 #
 version: 2
 jobs:
-  "ruby-2.3":
-    docker:
-       - image: hanami/ruby-2.3
-    working_directory: ~/hanami-utils
-    steps:
-      - checkout
-      # Download and cache dependencies
-      - restore_cache:
-          keys:
-          - v1-dependencies-{{ checksum "Gemfile.lock" }}
-          # fallback to using the latest cache if no exact match is found
-          - v1-dependencies-
-      - run:
-          name: install dependencies
-          command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-      # run tests!
-      - run:
-          name: run tests
-          command: |
-            ./script/ci
-  "ruby-2.4":
-    docker:
-       - image: hanami/ruby-2.4
-    working_directory: ~/hanami-utils
-    steps:
-      - checkout
-      # Download and cache dependencies
-      - restore_cache:
-          keys:
-          - v1-dependencies-{{ checksum "Gemfile.lock" }}
-          # fallback to using the latest cache if no exact match is found
-          - v1-dependencies-
-      - run:
-          name: install dependencies
-          command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-      # run tests!
-      - run:
-          name: run tests
-          command: |
-            ./script/ci
   "ruby-2.5":
     docker:
        - image: hanami/ruby-2.5
@@ -104,64 +54,10 @@ jobs:
           name: run tests
           command: |
             ./script/ci
-  "jruby-9.1":
-    docker:
-       - image: hanami/jruby-9.1
-    working_directory: ~/hanami-utils
-    steps:
-      - checkout
-      # Download and cache dependencies
-      - restore_cache:
-          keys:
-          - v1-dependencies-{{ checksum "Gemfile.lock" }}
-          # fallback to using the latest cache if no exact match is found
-          - v1-dependencies-
-      - run:
-          name: install dependencies
-          command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-      # run tests!
-      - run:
-          name: run tests
-          command: |
-            ./script/ci
-  "jruby-9.2":
-    docker:
-       - image: hanami/jruby-9.2
-    working_directory: ~/hanami-utils
-    steps:
-      - checkout
-      # Download and cache dependencies
-      - restore_cache:
-          keys:
-          - v1-dependencies-{{ checksum "Gemfile.lock" }}
-          # fallback to using the latest cache if no exact match is found
-          - v1-dependencies-
-      - run:
-          name: install dependencies
-          command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-      # run tests!
-      - run:
-          name: run tests
-          command: |
-            ./script/ci
 
 workflows:
   version: 2
   build:
     jobs:
-      - "ruby-2.3"
-      - "ruby-2.4"
       - "ruby-2.5"
       - "ruby-2.6"
-      - "jruby-9.1"
-      - "jruby-9.2"

data/.rubocop.yml

@@ -1,4 +1,4 @@
 # Please keep AllCops, Bundler, Style, Metrics groups and then order cops
 # alphabetically
 inherit_from:
-  - https://raw.githubusercontent.com/hanami/devtools/master/.rubocop.yml
+  - https://raw.githubusercontent.com/hanami/devtools/master/.rubocop-unstable.yml

data/.travis.yml

@@ -5,19 +5,13 @@ before_script:
   - gem update --system
 script: ./script/ci
 rvm:
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
-  - 2.6.0
-  - jruby-9.1.9.0
+  - 2.5
+  - 2.6
   - ruby-head
-  - jruby-head
 
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: jruby-9.1.9.0
 
 notifications:
   webhooks:

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Hanami::CLI
 General purpose Command Line Interface (CLI) framework for Ruby
 
+## v1.0.0.alpha1 - 2019-01-30
+### Added
+- [Luca Guidi] Inheritng from subclasses of `Hanami::CLI::Command`, allows to inherit arguments, options, description, and examples.
+- [Luca Guidi] Allow to use `super` from `#call`
+
+### Changed
+- [Luca Guidi] Drop support for Ruby: MRI 2.3, and 2.4.
+
 ## v0.3.1 - 2019-01-18
 ### Added
 - [Luca Guidi] Official support for Ruby: MRI 2.6

data/Gemfile

@@ -1,11 +1,12 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 gemspec
 
-unless ENV['CI']
-  gem 'byebug', require: false, platforms: :mri
-  gem 'yard',   require: false
+unless ENV["CI"]
+  gem "byebug", require: false, platforms: :mri
+  gem "yard",   require: false
 end
 
-gem 'hanami-utils', '~> 1.3', require: false, git: 'https://github.com/hanami/utils.git', branch: 'master'
-
-gem 'hanami-devtools', require: false, git: 'https://github.com/hanami/devtools.git'
+gem "hanami-utils", "~> 2.0.alpha", require: false, git: "https://github.com/hanami/utils.git", branch: "unstable"
+gem "hanami-devtools",              require: false, git: "https://github.com/hanami/devtools.git"

data/README.md

@@ -24,7 +24,7 @@ General purpose Command Line Interface (CLI) framework for Ruby.
 
 ## Rubies
 
-__Hanami::CLI__ supports Ruby (MRI) 2.3+, JRuby 9.1.5.0+
+__Hanami::CLI__ supports Ruby (MRI) 2.5+
 
 ## Installation
 
@@ -633,4 +633,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/hanami
 
 ## Copyright
 
-Copyright © 2017 Luca Guidi – Released under MIT License
+Copyright © 2017-2019 Luca Guidi – Released under MIT License

data/Rakefile

@@ -1,15 +1,17 @@
-require 'rake'
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'hanami/devtools/rake_tasks'
+# frozen_string_literal: true
+
+require "rake"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "hanami/devtools/rake_tasks"
 
 namespace :spec do
   RSpec::Core::RakeTask.new(:unit) do |task|
-    file_list = FileList['spec/**/*_spec.rb']
+    file_list = FileList["spec/**/*_spec.rb"]
     file_list = file_list.exclude("spec/{integration,isolation}/**/*_spec.rb")
 
     task.pattern = file_list
   end
 end
 
-task default: 'spec:unit'
+task default: "spec:unit"

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "hanami/cli"

data/hanami-cli.gemspec

@@ -1,6 +1,8 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hanami/cli/version'
+require "hanami/cli/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "hanami-cli"
@@ -13,18 +15,19 @@ Gem::Specification.new do |spec|
   spec.description   = "Hanami framework to build command line interfaces with Ruby"
   spec.homepage      = "http://hanamirb.org"
 
-  spec.metadata['allowed_push_host'] = "https://rubygems.org"
-  spec.metadata['source_code_uri'] = "https://github.com/hanami/cli"
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["source_code_uri"] = "https://github.com/hanami/cli"
 
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.5.0"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
 
-  spec.add_dependency "hanami-utils",    "~> 1.3"
+  spec.add_dependency "hanami-utils",    "~> 2.0.alpha"
   spec.add_dependency "concurrent-ruby", "~> 1.0"
 
   spec.add_development_dependency "bundler", ">= 1.6", "< 3"

data/lib/hanami/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Hanami
 #
 # @since 0.1.0

data/lib/hanami/cli/banner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "hanami/cli/program_name"
 
 module Hanami
@@ -81,8 +83,8 @@ module Hanami
         required_arguments = command.required_arguments
         optional_arguments = command.optional_arguments
 
-        required = required_arguments.map { |arg| arg.name.upcase }.join(' ') if required_arguments.any?
-        optional = optional_arguments.map { |arg| "[#{arg.name.upcase}]" }.join(' ') if optional_arguments.any?
+        required = required_arguments.map { |arg| arg.name.upcase }.join(" ") if required_arguments.any?
+        optional = optional_arguments.map { |arg| "[#{arg.name.upcase}]" }.join(" ") if optional_arguments.any?
         result = [required, optional].compact
 
         " #{result.join(' ')}" unless result.empty?

data/lib/hanami/cli/command.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require "forwardable"
 require "concurrent/array"
 require "hanami/cli/option"
+require "hanami/utils/class_attribute"
 
 module Hanami
   class CLI
@@ -20,32 +23,62 @@ module Hanami
       module ClassMethods
         # @since 0.1.0
         # @api private
+        #
+        # rubocop:disable Metrics/MethodLength
         def self.extended(base)
           super
+          return unless extend?(base)
 
           base.class_eval do
-            @description  = nil
-            @examples     = Concurrent::Array.new
-            @arguments    = Concurrent::Array.new
-            @options      = Concurrent::Array.new
-          end
-        end
+            include Utils::ClassAttribute
 
-        # @since 0.1.0
-        # @api private
-        attr_reader :description
+            class_attribute :description
+            self.description = nil
 
-        # @since 0.1.0
-        # @api private
-        attr_reader :examples
+            class_attribute :examples
+            self.examples = Concurrent::Array.new
 
-        # @since 0.1.0
-        # @api private
-        attr_reader :arguments
+            class_attribute :arguments
+            self.arguments = Concurrent::Array.new
 
-        # @since 0.1.0
+            class_attribute :options
+            self.options = Concurrent::Array.new
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        # Only add class attributes if a command is inheriting directly from `Hanami::CLI::Command`.
+        # In this way, its subclasses can inherit arguments/options from the parent class.
+        #
+        # @return [TrueClass,FalseClass] the result of the check
+        #
+        # @since 1.0.0
         # @api private
-        attr_reader :options
+        #
+        # @example
+        #   # For this class `extend?` will return `true`
+        #   class Server < Hanami::CLI::Command
+        #     option :engine
+        #
+        #     def call(**options)
+        #       # start the server
+        #     end
+        #   end
+        #
+        #   # For this class `extend?` will return `false`
+        #   class ServerReloader < Server
+        #     option :reload, type: :boolean, default: true
+        #
+        #     def call(**options)
+        #       reload = options.fetch(:reload)
+        #       super unless reload
+        #
+        #       # activate reloading
+        #     end
+        #   end
+        def self.extend?(base)
+          base.superclass == Hanami::CLI::Command
+        end
       end
 
       # Set the description of the command
@@ -65,7 +98,7 @@ module Hanami
       #     end
       #   end
       def self.desc(description)
-        @description = description
+        self.description = description
       end
 
       # Describe the usage of the command
@@ -101,7 +134,7 @@ module Hanami
       #   #     foo server --port=2306         # Bind to a port
       #   #     foo server --no-code-reloading # Disable code reloading
       def self.example(*examples)
-        @examples += examples.flatten
+        self.examples += examples.flatten
       end
 
       # Specify an argument
@@ -195,7 +228,7 @@ module Hanami
       #   #   Options:
       #   #     --help, -h          # Print this help
       def self.argument(name, options = {})
-        @arguments << Argument.new(name, options)
+        arguments << Argument.new(name, options)
       end
 
       # Command line option (aka optional argument)
@@ -309,13 +342,13 @@ module Hanami
       #   # Options:
       #   #   --port=VALUE, -p VALUE
       def self.option(name, options = {})
-        @options << Option.new(name, options)
+        self.options << Option.new(name, options)
       end
 
       # @since 0.1.0
       # @api private
       def self.params
-        (@arguments + @options).uniq
+        (arguments + options).uniq
       end
 
       # @since 0.1.0

data/lib/hanami/cli/command_registry.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require "concurrent/hash"
-require 'hanami/utils/callbacks'
+require "hanami/utils/callbacks"
 
 module Hanami
   class CLI

data/lib/hanami/cli/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "hanami/utils/deprecation"
 
 module Hanami
@@ -37,7 +39,7 @@ module Hanami
     # @since 0.2.1
     def self.const_missing(name)
       super unless name == :UnkwnownCommandError
-      Hanami::Utils::Deprecation.new('UnkwnownCommandError is deprecated, please use UnknownCommandError')
+      Hanami::Utils::Deprecation.new("UnkwnownCommandError is deprecated, please use UnknownCommandError")
       UnknownCommandError
     end
   end

data/lib/hanami/cli/option.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "hanami/utils/string"
 
 module Hanami

data/lib/hanami/cli/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "optparse"
 require "hanami/cli/program_name"
 

data/lib/hanami/cli/program_name.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Hanami
   class CLI
     # Program name
@@ -7,7 +9,7 @@ module Hanami
     module ProgramName
       # @since 0.1.0
       # @api private
-      SEPARATOR = " ".freeze
+      SEPARATOR = " "
 
       # @since 0.1.0
       # @api private

data/lib/hanami/cli/registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "hanami/cli/command_registry"
 
 module Hanami
@@ -260,7 +262,7 @@ module Hanami
 
       private
 
-      COMMAND_NAME_SEPARATOR = " ".freeze
+      COMMAND_NAME_SEPARATOR = " "
 
       # @since 0.2.0
       # @api private

data/lib/hanami/cli/usage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "hanami/cli/program_name"
 
 module Hanami
@@ -9,7 +11,7 @@ module Hanami
     module Usage
       # @since 0.1.0
       # @api private
-      SUBCOMMAND_BANNER = " [SUBCOMMAND]".freeze
+      SUBCOMMAND_BANNER = " [SUBCOMMAND]"
 
       # @since 0.1.0
       # @api private
@@ -50,8 +52,8 @@ module Hanami
         required_arguments = command.required_arguments
         optional_arguments = command.optional_arguments
 
-        required = required_arguments.map { |arg| arg.name.upcase }.join(' ') if required_arguments.any?
-        optional = optional_arguments.map { |arg| "[#{arg.name.upcase}]" }.join(' ') if optional_arguments.any?
+        required = required_arguments.map { |arg| arg.name.upcase }.join(" ") if required_arguments.any?
+        optional = optional_arguments.map { |arg| "[#{arg.name.upcase}]" }.join(" ") if optional_arguments.any?
         result = [required, optional].compact
 
         " #{result.join(' ')}" unless result.empty?

data/lib/hanami/cli/version.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Hanami
   class CLI
     # @since 0.1.0
-    VERSION = "0.3.1".freeze
+    VERSION = "1.0.0.alpha1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-cli
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0.alpha1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-18 00:00:00.000000000 Z
+date: 2019-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-utils
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.0.alpha
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.0.alpha
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -131,12 +131,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.2
 signing_key: