article_fixture_gen 0.1.1

data/lib/article_fixture_gen/exe/generate_config.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module ArticleFixtureGen
+  module Exe
+    # Save configuration as YAML to file specified *in* configuration.
+    class GenerateConfig
+      def self.call(config)
+        new(config).call
+      end
+
+      def call
+        return unless filename
+        write_output
+        data.freeze
+      end
+
+      protected
+
+      def initialize(config)
+        @data = Internals.filter_data(config)
+        @filename = config.generate_config.to_s
+        self
+      end
+
+      private
+
+      attr_reader :data, :filename
+
+      OMITTED_KEYS = [:config, :config_given, :generate_config,
+                      :generate_config_given].freeze
+      private_constant :OMITTED_KEYS
+
+      def write_output
+        # Using a File.open block raises an IOError within Psych (YAML internal)
+        outf = File.open(filename, 'w')
+        YAML.dump data, outf
+        outf.close
+      end
+
+      # Stateless methods
+      module Internals
+        def self.filter_data(config)
+          config.to_hash.reject { |attrib, _| OMITTED_KEYS.include? attrib }
+        end
+      end
+      private_constant :Internals
+    end # class ArticleFixtureGen::Exe::GenerateConfig
+  end
+end

data/lib/article_fixture_gen/exe/option_parser/trollop/option_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+require_relative './option_spec_item'
+
+module ArticleFixtureGen
+  module Exe
+    module Trollop
+      # Encapsulate configuration of a Trollop command-line option
+      class OptionSpec
+        extend Forwardable
+
+        def initialize(*key_and_desc, **options)
+          @item = OptionSpecItem.new key: key_and_desc[0],
+                                     desc: key_and_desc[1], options: options
+          # freeze # Cannot freeze data passed to `Trollop.opt`.
+          #          WTFometer at 11.
+          self
+        end
+
+        def add_option(context)
+          context.opt key, desc, options
+        end
+
+        def_delegators :@item, :desc, :key, :options
+      end # class ArticleFixtureGen::Exe::Trollop::OptionSpec
+    end
+  end
+end

data/lib/article_fixture_gen/exe/option_parser/trollop/option_spec_item.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'prolog/dry_types'
+
+module ArticleFixtureGen
+  module Exe
+    module Trollop
+      # Individual item hash for Trollop data. This can't be frozen per Trollop.
+      class OptionSpecItem < Dry::Struct
+        attribute :key, Types::Strict::Symbol
+        attribute :desc, Types::Strict::String
+        attribute :options, Types::Strict::Hash
+      end # class ArticleFixtureGen::Exe::Trollop::OptionSpecItem
+    end
+  end
+end

data/lib/article_fixture_gen/exe/option_parser/trollop/options_and_mods.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative './options_with_defaults'
+
+module ArticleFixtureGen
+  module Exe
+    module Trollop
+      # Adds modified attributes to lists produced by `OptionsWithDefaults`.
+      class OptionsAndMods
+        def self.call(all_specs)
+          new(all_specs).call
+        end
+
+        def call
+          container = OptionsWithDefaults.call(all_specs).to_hash
+          container[:modified] = Internals.modified_from(container)
+          Result.new container
+        end
+
+        protected
+
+        def initialize(all_specs)
+          @all_specs = all_specs
+          self
+        end
+
+        private
+
+        attr_reader :all_specs
+
+        # Stateless methods
+        module Internals
+          def self.modified_from(container)
+            _modified_attributes(container).reject do |attrib, _|
+              [:help, :version].include? attrib
+            end
+          end
+
+          def self._modified_attributes(container)
+            container[:options].reject do |attrib, value|
+              container[:defaults][attrib] == value
+            end
+          end
+        end
+        private_constant :Internals
+
+        # Encapsulates configured options, default values, and modified options.
+        class Result < Dry::Struct
+          attribute :defaults, Types::Strict::Hash
+          attribute :modified, Types::Strict::Hash
+          attribute :options, Types::Strict::Hash
+        end
+        private_constant :Result
+      end # class ArticleFixtureGen::Exe::Trollop::OptionsAndMods
+    end
+  end
+end

data/lib/article_fixture_gen/exe/option_parser/trollop/options_with_defaults.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'trollop'
+
+module ArticleFixtureGen
+  module Exe
+    module Trollop
+      # Builds an encapsulation of Trollop option menu and default values.
+      class OptionsWithDefaults
+        USAGE_BANNER = \
+          "Generates article/blog post fixture data based on settings.\n" \
+          "Usage:\n\n" \
+          "  #{File.basename($PROGRAM_NAME)} [options]\n\n" \
+          'where [options] are any of:'
+        private_constant :USAGE_BANNER
+
+        VERSION_BANNER = "#{$PROGRAM_NAME} Version " \
+          "#{ArticleFixtureGen::VERSION}\n" \
+          'Copyright (c)2016, Jeff Dickey and Prolog Systems (S) Pte Ltd'
+        private_constant :VERSION_BANNER
+
+        # Reek says this method has :reek:TooManyStatements. Such is a DSL.
+        def self.call(all_specs)
+          defaults = {}
+          options = ::Trollop.options do
+            version VERSION_BANNER
+            banner USAGE_BANNER
+            all_specs.map { |spec| spec.add_option self }
+            # Reminder: `all_specs` is our data. `Trollop.specs` is valid only
+            #           inside the `.options` block
+            specs.each { |attrib, spec| defaults[attrib] = spec[:default] }
+          end
+          Result.new defaults: defaults, options: options
+        end
+
+        # Encapsulates Trollop option menu and default values.
+        class Result < Dry::Struct
+          attribute :defaults, Types::Strict::Hash
+          attribute :options, Types::Strict::Hash
+        end
+        private_constant :Result
+      end # class ArticleFixtureGen::Exe::Trollop::OptionsWithDefaults
+    end
+  end
+end

data/lib/article_fixture_gen/exe/option_parser/trollop/validator.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'trollop'
+
+module ArticleFixtureGen
+  module Exe
+    module Trollop
+      # Validates attribute values using evaled code from YAML file.
+      class Validator
+        def self.call(option_data)
+          new(option_data).call
+        end
+
+        def call
+          Internals.validations.map do |validation|
+            validate(validation)
+          end
+          option_data
+        end
+
+        protected
+
+        def initialize(option_data)
+          @option_data = option_data
+          self
+        end
+
+        private
+
+        attr_reader :option_data
+
+        def options
+          option_data.options
+        end
+
+        # Reek calls out :reek:FeatureEnvy on `validation`. Pffft.
+        def validate(validation)
+          die_params = [validation[:key], validation[:str]]
+          ::Trollop.die(*die_params) if validation_failed?(validation)
+          true
+        end
+
+        def validation_failed?(validation)
+          validation_proc_for(validation).call options
+        end
+
+        def validation_proc_for(validation)
+          # rubocop:disable Lint/Eval
+          eval(validation[:fails_with])
+          # rubocop:enable Lint/Eval
+        end
+
+        # Stateless methods
+        module Internals
+          def self.validations
+            YAML.load_file 'data/validations.yml'
+          end
+        end
+        private_constant :Internals
+      end # class ArticleFixtureGen::Exe::Trollop::Validator
+    end
+  end
+end

data/lib/article_fixture_gen/exe/option_parser/trollop.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'trollop'
+
+require 'prolog/dry_types'
+
+require_relative './trollop/option_spec'
+require_relative './trollop/options_and_mods'
+require_relative './trollop/validator'
+
+module ArticleFixtureGen
+  module Exe
+    module Trollop
+      # Parse command-line options using Trollop. Note that Trollop is one-shot
+      # stateful; it is apparently not possible to reset/rewind status once a
+      # command line has been parsed without writing directly to ARGV.
+      class OptionParser
+        def self.call
+          option_data = OptionsAndMods.call Internals.all_specs
+          Internals.result_from option_data
+        end
+
+        # Stateless methods
+        module Internals
+          # NOTE: This is only "direct" user of `OptionSpec`, which is only
+          #       direct user of `OptionSpecItem`.
+          def self.all_specs
+            YAML.load_file 'data/all_specs.yml'
+          end
+
+          def self.result_from(option_data)
+            # validate(option_data)
+            Validator.call option_data
+            Result.new modified: option_data.modified,
+                       options: option_data.options
+          end
+        end
+        private_constant :Internals
+
+        # Encapsulates active and modified command-line option data.
+        class Result < Dry::Struct
+          attribute :modified, Types::Hash
+          attribute :options, Types::Hash
+        end
+        private_constant :Result
+      end # class ArticleFixtureGen::Exe::Trollop::OptionParser
+    end
+  end
+end

data/lib/article_fixture_gen/exe/option_parser.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'option_parser/trollop'
+
+module ArticleFixtureGen
+  module Exe
+    # Individual item hash based on parser, such as Trollop. To change to a
+    # different parser, implement an equivalent of `Trollop::OptionParser` with
+    # the new parser and change the parent class of this class. Voila.
+    class OptionParser < Trollop::OptionParser
+    end # class ArticleFixtureGen::Exe::OptionParser
+  end
+end

data/lib/article_fixture_gen/support/logging.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'semantic_logger'
+
+log_env_str = ENV['RACK_ENV'] || 'dev'
+log_fname = "log/#{log_env_str}.log"
+log_level_default = %w(dev test).include?(log_env_str) ? 'trace' : 'info'
+log_level_str = ENV['LOG_LEVEL'] || log_level_default
+
+# Variations:
+#
+# 1. `bundle exec ruby test/path/to/your_test.rb` will log to `log/test.log` at
+#    log level `info` unless your environment variables are set to override;
+# 2. `RACK_ENV=dev bundle exec ruby test/path/to/your_test.rb` will log to
+#    `log/dev.log` at log level `trace` unless the `LOG_LEVEL` environment
+#    variable overrides the level setting;
+# 3. `LOG_LEVEL=trace bundle exec ruby test/path/to/your_test.rb` will log to
+#    `log/test.log` unless the `RACK_ENV` setting overrides the filename, at log
+#    level `trace`.
+#
+# The file `test/test_helper.rb` sets the default `RACK_ENV` to `test` unless
+# already set.
+
+SemanticLogger.default_level = log_level_str.downcase.to_sym
+SemanticLogger.add_appender file_name: log_fname, formatter: :color

data/lib/article_fixture_gen/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Generate blog post/article fixture data, with embedded marker tag pairs.
+module ArticleFixtureGen
+  VERSION = '0.1.1'
+end

data/lib/article_fixture_gen.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'article_fixture_gen/data/article'
+require 'article_fixture_gen/config'
+require 'article_fixture_gen/version'
+
+# Generate blog post/article fixture data, with embedded marker tag pairs.
+module ArticleFixtureGen
+  # Your code goes here...
+end

data/lib/tasks/prolog_flog_task.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rake/tasklib'
+require 'flog'
+require 'flog_task'
+
+# Redefinition of standard task's Rake invocation. Because we don't like
+# inconsistency in option settings.
+class FlogTask < Rake::TaskLib
+  # Reek bitches that this is a :reek:Attribute (writable). That's the *point*.
+  attr_accessor :methods_only
+end

data/vendor/ruby/2.3.0/bin/article_fixture_gen

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by RubyGems.
+#
+# The application 'article_fixture_gen' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0.a"
+
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/ and Gem::Version.correct?($1) then
+    version = $1
+    ARGV.shift
+  end
+end
+
+load Gem.activate_bin_path('article_fixture_gen', 'article_fixture_gen', version)