defmastership 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 86de2f3ea5bbabfae9ed3e773349016d3a122919091bb04d2134dc2de25799a2
+  data.tar.gz: e3d082d8d7f6ee8a22fe178c5eb9691cb6934dae4fff0c6288be0f17e6f94273
+SHA512:
+  metadata.gz: 69e865bb1c8e5972d7aa12b5f6ce9203e9d27eadcfef7c3f2becb83b123920769a120e66896957bc26eb89efbe7e9a00389c5262d4d395e2bdb9602b0f3f335c
+  data.tar.gz: cad9f387a71e9668ba1af813865ba161c95daaa4937defa0c42ad41a72b7b3225ad0e3b7ccb5eeefa0553f33b2bd6e3aa6774567fe2bba6d6ea560952190de96

data/.gitignore

@@ -0,0 +1,4 @@
+/*_results.html
+/tmp
+/coverage
+defmastership-0.0.1.gem

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--format html --out rspec_results.html
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,63 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+  EnabledByDefault: true
+  DisplayCopNames: true
+
+Style/Copyright:
+  Enabled: false
+  # AutocorrectNotice: 'Copyright 2020 by Jérôme Arbez-Gindre'
+
+Lint/ConstantResolution:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+
+Style/StringHashKeys :
+  Enabled: false
+
+Style/MissingElse:
+  EnforcedStyle: case
+
+Metrics/ModuleLength :
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/BlockLength :
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+
+Security/Eval :
+  Exclude:
+    - 'Rakefile'
+
+Style/ConstantVisibility :
+  Exclude:
+     # there is one unique explicit constant visibility for all
+     # constants
+    - 'lib/defmastership/constants.rb'
+
+# rubocop-rspec options
+RSpec/MessageExpectation :
+  Enabled: false
+
+RSpec/FilePath :
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source('https://rubygems.org')
+gemspec

data/Gemfile.lock

@@ -0,0 +1,140 @@
+PATH
+  remote: .
+  specs:
+    defmastership (1.0.1)
+      aasm (~> 5)
+      asciidoctor (~> 2)
+      gli (~> 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aasm (5.1.1)
+      concurrent-ruby (~> 1.0)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    aruba (1.0.3)
+      childprocess (>= 2.0, < 5.0)
+      contracts (~> 0.16.0)
+      cucumber (>= 2.4, < 6.0)
+      ffi (~> 1.9)
+      rspec-expectations (~> 3.4)
+      thor (~> 1.0)
+    asciidoctor (2.0.10)
+    ast (2.4.1)
+    builder (3.2.4)
+    childprocess (4.0.0)
+    concurrent-ruby (1.1.7)
+    contracts (0.16.0)
+    cucumber (5.1.1)
+      builder (~> 3.2, >= 3.2.4)
+      cucumber-core (~> 8.0, >= 8.0.1)
+      cucumber-create-meta (~> 2.0, >= 2.0.2)
+      cucumber-cucumber-expressions (~> 10.3, >= 10.3.0)
+      cucumber-gherkin (~> 15.0, >= 15.0.2)
+      cucumber-html-formatter (~> 9.0, >= 9.0.0)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+      cucumber-wire (~> 4.0, >= 4.0.1)
+      diff-lcs (~> 1.4, >= 1.4.4)
+      multi_test (~> 0.1, >= 0.1.2)
+      sys-uname (~> 1.2, >= 1.2.1)
+    cucumber-core (8.0.1)
+      cucumber-gherkin (~> 15.0, >= 15.0.2)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+      cucumber-tag-expressions (~> 2.0, >= 2.0.4)
+    cucumber-create-meta (2.0.2)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+      sys-uname (~> 1.2, >= 1.2.1)
+    cucumber-cucumber-expressions (10.3.0)
+    cucumber-gherkin (15.0.2)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+    cucumber-html-formatter (9.0.0)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+    cucumber-messages (13.0.1)
+      protobuf-cucumber (~> 3.10, >= 3.10.8)
+    cucumber-tag-expressions (2.0.4)
+    cucumber-wire (4.0.1)
+      cucumber-core (~> 8.0, >= 8.0.1)
+      cucumber-cucumber-expressions (~> 10.3, >= 10.3.0)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    ffi (1.13.1)
+    gli (2.19.2)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    middleware (0.1.0)
+    minitest (5.14.2)
+    multi_test (0.1.2)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    protobuf-cucumber (3.10.8)
+      activesupport (>= 3.2)
+      middleware
+      thor
+      thread_safe
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rdoc (6.2.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.90.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    rubocop-rspec (1.43.2)
+      rubocop (~> 0.87)
+    ruby-progressbar (1.10.1)
+    simplecov (0.19.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    sys-uname (1.2.1)
+      ffi (>= 1.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (~> 1)
+  defmastership!
+  rake (~> 13)
+  rdoc (~> 6)
+  rspec (~> 3)
+  rubocop (~> 0)
+  rubocop-rspec (~> 1)
+  simplecov (~> 0)
+
+BUNDLED WITH
+   2.1.4

data/README.rdoc

@@ -0,0 +1,6 @@
+= defmastership
+
+Describe your project here
+
+:include:defmastership.rdoc
+

data/Rakefile

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require('rake/clean')
+require('rubygems')
+require('rubygems/package_task')
+require('rdoc/task')
+require('cucumber')
+require('cucumber/rake/task')
+
+Rake::RDocTask.new do |rd|
+  rd.main = 'README.rdoc'
+  rd.rdoc_files.include('README.rdoc', 'lib/**/*.rb', 'bin/**/*')
+  rd.title = 'Your application title'
+end
+
+spec = eval(::File.read('defmastership.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+CUKE_RESULTS = 'features_results.html'
+CLEAN << CUKE_RESULTS
+
+desc('Run features')
+::Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts = opts
+  t.fork = false
+end
+
+desc('Run features tagged as work-in-progress (@wip)')
+::Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending' \
+             ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} "\
+                    "--format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task(cucumber: :features)
+task(wip: 'features:wip')
+
+require('bundler/gem_tasks')
+
+require('rspec/core/rake_task')
+
+::RSpec::Core::RakeTask.new(:spec)
+
+require('rubocop/rake_task')
+
+::RuboCop::RakeTask.new
+
+task(default: %i[spec features rubocop])

data/bin/defmastership

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require('asciidoctor')
+require('csv')
+require('defmastership')
+require('gli')
+
+module DefMastership
+  # The start of everything !
+  class App
+    extend GLI::App
+
+    program_desc 'Tool to handle Asciidoctor definition extension'
+
+    version DefMastership::VERSION
+
+    subcommand_option_handling :normal
+    arguments :strict
+
+    # desc 'Describe some switch here'
+    # switch [:s,:switch]
+
+    # desc 'Describe some flag here'
+    # default_value 'the default'
+    # arg_name 'The name of the argument'
+    # flag [:f,:flagname]
+
+    pre do |_global, _command, _options, _args|
+      # Pre logic here
+      # Return true to proceed; false to abort and not call the
+      # chosen command
+      # Use skips_pre before a command to skip this block
+      # on that command only
+      true
+    end
+
+    post do |_global, _command, _options, _args|
+      # Post logic here
+      # Use skips_post before a command to skip this
+      # block on that command only
+    end
+
+    on_error do |_exception|
+      # Error logic here
+      # return false to skip default error handling
+      true
+    end
+
+    desc 'Export the definition database in CSV'
+    arg_name 'asciidoctor_files'
+    command :export do |c|
+      c.action do |_global_options, _options, args|
+        doc = Asciidoctor.load_file(args[0], safe: :unsafe, parse: false)
+        # FIXME: also escape ifdef, ifndef, ifeval and endif directives
+        # FIXME: do this more carefully by reading line by line; if input
+        # differs by output by leading backslash, restore original line
+        lines = doc.reader.read_lines
+        my_doc = DefMastership::Document.new
+        my_doc.parse(lines)
+
+        output_file = args[0].sub(/\.adoc$/, '.csv')
+
+        DefMastership::CSVFormatter.new(my_doc).export_to(output_file)
+      end
+    end
+
+    desc 'Change temp references to definitive references'
+    arg_name 'asciidoctor_files'
+    command :changeref do |c|
+      c.flag(%i[change-summary s], default_value: 'changes.csv', desc: 'generates a change summary in a CSV file')
+
+      c.flag(%i[change-file f], default_value: 'changeref.yaml', desc: 'set the change specification file')
+
+      c.action do |_global_options, options, args|
+        ref_changer = ProjectRefChanger.new(
+          YAML.load_file(options['change-file']),
+          args.map { |afile| [afile, File.open(afile).read] }.to_h
+        )
+
+        ref_changer.replace_all
+
+        ref_changer.adoc_texts.each do |adoc_file, adoc_text|
+          File.open(adoc_file, 'w') { |f| f.write(adoc_text) }
+        end
+        File.open(options['change-file'], 'w') { |f| f.write(ref_changer.yaml_config) }
+
+        unless options['change-summary'].nil?
+          CSV.open(options['change-summary'], 'wb') do |csv|
+            csv << %w[Was Becomes]
+            ref_changer.changes.each { |row| csv << row }
+          end
+        end
+      end
+    end
+  end
+end
+
+exit(DefMastership::App.run(ARGV))

data/config/devtools.yml

@@ -0,0 +1,2 @@
+---
+unit_test_timeout: 0.2

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 8
+total_score: 119

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 13.5

data/config/mutant.yml

@@ -0,0 +1,6 @@
+---
+includes:
+- lib
+integration: rspec
+requires:
+- devtools

data/config/reek.yml

@@ -0,0 +1,106 @@
+---
+detectors:
+  Attribute:
+    enabled: false
+    exclude: []
+  BooleanParameter:
+    enabled: true
+    exclude: []
+  ClassVariable:
+    enabled: true
+    exclude: []
+  ControlParameter:
+    enabled: true
+    exclude: []
+  DataClump:
+    enabled: true
+    exclude: []
+    max_copies: 0
+    min_clump_size: 2
+  DuplicateMethodCall:
+    enabled: true
+    exclude: []
+    max_calls: 1
+    allow_calls: []
+  FeatureEnvy:
+    enabled: true
+    exclude: []
+  IrresponsibleModule:
+    enabled: true
+    exclude: []
+  LongParameterList:
+    enabled: true
+    exclude:
+    - Devtools::Config#self.attribute
+    max_params: 2
+    overrides: {}
+  LongYieldList:
+    enabled: true
+    exclude: []
+    max_params: 0
+  NestedIterators:
+    enabled: true
+    exclude: []
+    max_allowed_nesting: 1
+    ignore_iterators: []
+  NilCheck:
+    enabled: true
+    exclude: []
+  RepeatedConditional:
+    enabled: true
+    exclude: []
+    max_ifs: 1
+  TooManyConstants:
+    enabled: true
+    exclude:
+    - Devtools
+  TooManyInstanceVariables:
+    enabled: true
+    exclude: []
+    max_instance_variables: 2
+  TooManyMethods:
+    enabled: true
+    exclude: []
+    max_methods: 15
+  TooManyStatements:
+    enabled: true
+    exclude: []
+    max_statements: 5
+  UncommunicativeMethodName:
+    enabled: true
+    exclude: []
+    reject:
+    - '/^[a-z]$/'
+    - '/[0-9]$/'
+    - '/[A-Z]/'
+    accept: []
+  UncommunicativeModuleName:
+    enabled: true
+    exclude: []
+    reject:
+    - '/^.$/'
+    - '/[0-9]$/'
+    accept: []
+  UncommunicativeParameterName:
+    enabled: true
+    exclude: []
+    reject:
+    - '/^.$/'
+    - '/[0-9]$/'
+    - '/[A-Z]/'
+    accept: []
+  UncommunicativeVariableName:
+    enabled: true
+    exclude: []
+    reject:
+    - '/^.$/'
+    - '/[0-9]$/'
+    - '/[A-Z]/'
+    accept: []
+  UnusedParameters:
+    enabled: true
+    exclude: []
+  UtilityFunction:
+    enabled: true
+    exclude:
+    - Devtools::Project::Initializer::Rspec#require_files # intentional for deduplication