hexx 7.1.0 → 8.0.0

data/config/metrics/cane.yml

@@ -0,0 +1,5 @@
+---
+abc_max: "10"
+line_length: "80"
+no_doc: "y"
+no_readme: "y"

data/config/metrics/churn.yml

@@ -0,0 +1,6 @@
+---
+ignore_files:
+- spec
+- config
+minimum_churn_count: 0
+start_date: "1 year ago"

data/config/metrics/flay.yml

@@ -0,0 +1,2 @@
+---
+minimum_score: 10

data/config/metrics/metric_fu.yml

@@ -0,0 +1,15 @@
+---
+folders: # The list of folders to be used by any metric.
+- lib
+- app
+metrics: # The list of allowed metrics. The other metrics are disabled.
+- cane
+- churn
+- flay
+- flog
+- reek
+- roodi
+- saikuro
+format: html
+output: tmp/metric_fu
+verbose: false

data/config/metrics/pippi.yml

@@ -0,0 +1,3 @@
+---
+checkset: basic
+output: "tmp/pippi/output.log"

data/config/metrics/reek.yml

@@ -0,0 +1 @@
+---

data/config/metrics/roodi.yml

@@ -0,0 +1,24 @@
+---
+AssignmentInConditionalCheck:
+CaseMissingElseCheck:
+ClassLineCountCheck:
+  line_count: 300
+ClassNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ClassVariableCheck:
+CyclomaticComplexityBlockCheck:
+  complexity: 4
+CyclomaticComplexityMethodCheck:
+  complexity: 8
+EmptyRescueBodyCheck:
+ForLoopCheck:
+MethodLineCountCheck:
+  line_count: 20
+MethodNameCheck:
+  pattern: !ruby/regexp /^[\||\^|\&|\!]$|^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/
+ModuleLineCountCheck:
+  line_count: 300
+ModuleNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ParameterNumberCheck:
+  parameter_count: 5

data/config/metrics/rubocop.yml

@@ -0,0 +1,79 @@
+---
+# settings added by the 'hexx-suit' module
+# output: "tmp/rubocop"
+# format: "html"
+
+AllCops:
+  Exclude:
+    - '**/db/schema.rb'
+
+Lint/HandleExceptions:
+  Exclude:
+    - '**/*_spec.rb'
+
+Lint/RescueException:
+  Exclude:
+    - '**/*_spec.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - '**/generator.rb'
+
+Style/AccessorMethodName:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/Documentation:
+  Exclude:
+    - '**/version.rb'
+    - '**/*_spec.rb'
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundMethodBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/EmptyLineBetweenDefs:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SingleLineMethods:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - '**/Gemfile'
+    - '**/*.gemspec'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrivialAccessors:
+  Exclude:
+    - '**/*_spec.rb'

data/config/metrics/saikuro.yml

@@ -0,0 +1,3 @@
+---
+warn_cyclo:  4
+error_cyclo: 6

data/config/metrics/simplecov.yml

@@ -0,0 +1,6 @@
+---
+output: tmp/coverage
+filters: # The list of paths to be excluded from coverage checkup
+- "spec/"
+- "config/"
+groups: []

data/config/metrics/yardstick.yml

@@ -0,0 +1,37 @@
+---
+# Settings added by the 'hexx-suit' gem
+output: "tmp/yardstick/output.log"
+path: "lib/**/*.rb"
+rules:
+  ApiTag::Presence:
+    enabled: true
+    exclude: []
+  ApiTag::Inclusion:
+    enabled: true
+    exclude: []
+  ApiTag::ProtectedMethod:
+    enabled: true
+    exclude: []
+  ApiTag::PrivateMethod:
+    enabled: false
+    exclude: []
+  ExampleTag:
+    enabled: true
+    exclude: []
+  ReturnTag:
+    enabled: true
+    exclude: []
+  Summary::Presence:
+    enabled: true
+    exclude: []
+  Summary::Length:
+    enabled: true
+    exclude: []
+  Summary::Delimiter:
+    enabled: true
+    exclude: []
+  Summary::SingleLine:
+    enabled: true
+    exclude: []
+threshold: 100
+verbose: false

data/hexx.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "hexx/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hexx"
+  s.version     = Hexx::VERSION.dup
+  s.author      = "Andrew Kozin"
+  s.email       = "andrew.kozin@gmail.com"
+  s.homepage    = "https://github.com/nepalez/hexx"
+  s.description = "Collection of scaffolders."
+  s.summary     = "Collection of scaffolders for projects that follow " \
+                  "the hexagonal architecture."
+  s.license     = "MIT"
+  s.platform    = Gem::Platform::RUBY
+  s.required_ruby_version = ">= 2.1"
+
+  s.require_paths    = ["lib"]
+  s.files            = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.test_files       = Dir["spec/**/*.rb"]
+  s.extra_rdoc_files = Dir["README.md", "LICENSE", "config/metrics/STYLEGUIDE"]
+
+  s.add_runtime_dependency "extlib", "~> 0.9"
+  s.add_runtime_dependency "hexx-suit", "~> 0.0"
+end

data/lib/hexx.rb

@@ -1,18 +1,11 @@
-# encoding: utf-8
-require "active_model"
-require "wisper"
+# encodint: utf-8
+require "hexx-suit"
 
-# Loading gem code (the order is essential).
-root = File.expand_path "../hexx", __FILE__
-Dir[
-  "#{ root }/creators/*.rb",
-  "#{ root }/helpers/*.rb",
-  "#{ root }/models/**/*.rb",
-  "#{ root }/service/**/*.rb",
-  "#{ root }/**/*.rb"
-].each { |f| require f }
+require_relative "../config/initializer"
+require_relative "hexx/generator"
+require_relative "hexx/name"
 
-# @api show
-# Namespace for the gem.
+# Collection of scaffolders for projects that follows the Hexagonal architecture
 module Hexx
-end
+
+end # module Hexx

data/lib/hexx/generator.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+require_relative "generator/file"
+require_relative "generator/folder"
+
+module Hexx
+
+  # Base class for scaffolders
+  #
+  # Adds actions to the generator
+  #
+  # @example (see #from_template)
+  # @example (see #copy_folder)
+  class Generator < Thor::Group
+    include Thor::Actions
+
+    private
+
+    # Returns source root defined for the class
+    #
+    # @return [String, Array<String>]
+    def source_root
+      self.class.send :source_root
+    end
+
+    # Returns content of source (relative to source root), preprocessed by ERB
+    #
+    # @example
+    #   # source_root/file.erb
+    #   <%= 2 * 2 %>
+    #
+    #   scaffolder = Hexx::Generator.new
+    #   scaffolder.send :from_template, "file.erb"
+    #   # => "4"
+    #
+    # @return [#to_s] source
+    #
+    # @api public
+    def from_template(source)
+      path    = find_in_source_paths(source)
+      content = ::File.read(path)
+      ERB.new(content, nil, "-").result
+    end
+
+    # Copies files from source folder into the destination one
+    #
+    # Wherein:
+    #
+    # * Files with a '.erb' extension are treated as templates and preprocessed
+    #   by ERB. They saved under initial names without '.erb' extension.
+    #
+    # * The underscore symbol "_" in the beginning of filename is removed.
+    #   You can copy dotfiles by underscoring them.
+    #
+    # @example
+    #   scaffolder = Hexx::Generator.new
+    #
+    #   scaffolder.copy_folder "root", "spec", skip: true
+    #   # root/_.settings         --> spec/.settings
+    #   # root/spec_helper.rb.erb --> spec/spec_helper.rb
+    #   # root/tests/test_spec.rb --> spec/tests/test_spec.rb
+    #
+    # @return [undefined]
+    #
+    # @api public
+    def copy_folder(source, target = source, options = {})
+      Folder.new(self).copy(source, target, options)
+    end
+
+  end # class Generator
+
+end # module Hexx

data/lib/hexx/generator/file.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+require "pathname"
+
+module Hexx
+
+  # Utilities to copy files and folders in a scaffolder context
+  class Generator < Thor::Group
+
+    # Copies a file from a source path to the target folder
+    #
+    # * Files, that have '.erb' extension, are pre-processed as erb templates.
+    # * The starting "_" symbol is removed from a file name.
+    #
+    # @api private
+    class File
+
+      # @!scope class
+      # @!method new(scaffolder, source, target, options = {})
+      # Constructs the processor for given scaffolder, source and target paths
+      #
+      # @param [Thor::Actions] scaffolder
+      #   the decorated scaffolder
+      # @param [Pathname] source
+      #   the source folder path to take file from
+      # @param [Pathname] target
+      #   the target folder path to copy file to
+      # @param [Hash] options
+      #   the list of options to copy file
+      #
+      # @return [Hexx::Processors::File]
+      def initialize(scaffolder, source, target, options = {})
+        @__scaffolder__ = scaffolder
+        @source  = source
+        @target  = target
+        @options = options
+      end
+
+      # Makes a copy of given source file
+      #
+      # @param  [Pathname] source_file
+      #
+      # @return [self] itself
+      def copy(source_file)
+        @source_file = source_file
+        __scaffolder__.send(copy_method, source_path, target_path, options)
+
+        self
+      end
+
+      private
+
+      attr_reader :__scaffolder__, :source, :target, :options, :source_file
+
+      def source_root
+        @source_root ||= Pathname.new __scaffolder__.send(:source_root)
+      end
+
+      def copy_method
+        (source_file.extname == ".erb") ? :template : :copy_file
+      end
+
+      def source_path
+        source_file.relative_path_from(source_root).to_s
+      end
+
+      def target_path
+        (target_dirname + target_filename).to_s
+      end
+
+      def target_dirname
+        target + source_file.relative_path_from(source).dirname
+      end
+
+      def target_filename
+        basename = source_file.basename(".erb").to_s
+        basename[0] == "_" ? basename[1..-1].to_s : basename
+      end
+
+    end # class File
+
+  end # class Generator
+
+end # module Hexx

data/lib/hexx/generator/folder.rb

@@ -0,0 +1,68 @@
+module Hexx
+
+  class Generator < Thor::Group
+
+    # Copies all files from a source folder to the target one
+    #
+    # * Files, that have '.erb' extension, are pre-processed as erb templates.
+    # * The starting "_" symbol is removed from a file name.
+    #
+    # @api private
+    class Folder
+
+      # @!scope class
+      # @!method new(scaffolder)
+      # Constructs the processor for given scaffolder
+      #
+      # @param [Thor::Actions] scaffolder
+      #
+      # @return [Hexx::Processors::Folder]
+      def initialize(scaffolder)
+        @__scaffolder__ = scaffolder
+      end
+
+      # Copies a source folder content to the target folder
+      #
+      # @param  [String] source
+      #   The source folder path relative to the scaffolder's source_root
+      # @param  [String] target
+      #   The target folder path relative to the scaffolder's destination_root
+      # @param  [Hash] options
+      #
+      # @return [self] itself
+      def copy(source, target, options = {})
+        @source, @target, @options = source, target, options
+        source_files.each { |file| file_processor.copy(file) }
+
+        self
+      end
+
+      private
+
+      attr_reader :__scaffolder__, :source, :target, :options
+
+      def source_files
+        source_paths.map(&Pathname.method(:new)).select(&:file?)
+      end
+
+      def file_processor
+        File.new __scaffolder__, source_folder, target_folder, options
+      end
+
+      def source_paths
+        ::Dir[source_folder + "**/*"]
+      end
+
+      def source_folder
+        Pathname.new(__scaffolder__.send :source_root).join(source)
+      end
+
+      def target_folder
+        Pathname.new(__scaffolder__.send :destination_root).join(target)
+      end
+
+    end # class Folder
+
+  end # class Generator
+
+end # module Hexx