rubysmith 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6500ee76663913e7e85d064b5629c7f2e7366e6c4ac0015108c68ef58347be58
+  data.tar.gz: 7999ae8f922c9548314599c551523005c09dfbf4aa72a8c5c4358cc2bc2d8feb
+SHA512:
+  metadata.gz: 4fa61bddb36ed3e1932c8992ed2ebfefefd294f1d2ff13b309d4b536c4d2984abbf78555fc5fad414814c8aa162ac1f9a6e2aa8c67ba31fdead382838aab6ae0
+  data.tar.gz: 5940e066becdd98146ce18991bb510b2bb8a4d66d165be5c1325b1217e7c3478213323921978fd97e5bc3a88e63acd7ff5fc5f58100ebd5988557ed6772e334b

data/LICENSE.adoc

@@ -0,0 +1,162 @@
+= Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+== 1. Definitions
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by
+Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is
+granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are
+controlled by, or are under common control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this
+License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to
+software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a
+Source form, including but not limited to compiled object code, generated documentation, and
+conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the
+License, as indicated by a copyright notice that is included in or attached to the work (an example
+is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or
+derived from) the Work and for which the editorial revisions, annotations, elaborations, or other
+modifications represent, as a whole, an original work of authorship. For the purposes of this
+License, Derivative Works shall not include works that remain separable from, or merely link (or
+bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any
+modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted
+to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity
+authorized to submit on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent to the Licensor or
+its representatives, including but not limited to communication on electronic mailing lists, source
+code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor
+for the purpose of discussing and improving the Work, but excluding communication that is
+conspicuously marked or otherwise designated in writing by the copyright owner as "Not a
+Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a
+Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+== 2. Grant of Copyright License
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a
+perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and
+distribute the Work and such Derivative Works in Source or Object form.
+
+== 3. Grant of Patent License
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a
+perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
+section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer
+the Work, where such license applies only to those patent claims licensable by such Contributor that
+are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You institute patent litigation
+against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or
+a Contribution incorporated within the Work constitutes direct or contributory patent infringement,
+then any patent licenses granted to You under this License for that Work shall terminate as of the
+date such litigation is filed.
+
+== 4. Redistribution
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
+or without modifications, and in Source or Object form, provided that You meet the following
+conditions:
+
+. You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+. You must cause any modified files to carry prominent notices stating that You changed the files;
+  and
+
+. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
+  patent, trademark, and attribution notices from the Source form of the Work, excluding those
+  notices that do not pertain to any part of the Derivative Works; and
+
+. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works
+  that You distribute must include a readable copy of the attribution notices contained within such
+  NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in
+  at least one of the following places: within a NOTICE text file distributed as part of the
+  Derivative Works; within the Source form or documentation, if provided along with the Derivative
+  Works; or, within a display generated by the Derivative Works, if and wherever such third-party
+  notices normally appear. The contents of the NOTICE file are for informational purposes only and
+  do not modify the License. You may add Your own attribution notices within Derivative Works that
+  You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such
+  additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or
+different license terms and conditions for use, reproduction, or distribution of Your modifications,
+or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of
+the Work otherwise complies with the conditions stated in this License.
+
+== 5. Submission of Contributions
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the
+Work by You to the Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed with Licensor regarding such
+Contributions.
+
+== 6. Trademarks
+
+This License does not grant permission to use the trade names, trademarks, service marks, or product
+names of the Licensor, except as required for reasonable and customary use in describing the origin
+of the Work and reproducing the content of the NOTICE file.
+
+== 7. Disclaimer of Warranty
+
+Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties or conditions of
+TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely
+responsible for determining the appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+== 8. Limitation of Liability
+
+In no event and under no legal theory, whether in tort (including negligence), contract, or
+otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or
+agreed to in writing, shall any Contributor be liable to You for damages, including any direct,
+indirect, special, incidental, or consequential damages of any character arising as a result of this
+License or out of the use or inability to use the Work (including but not limited to damages for
+loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial
+damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+== 9. Accepting Warranty or Additional Liability
+
+While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee
+for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights
+consistent with this License. However, in accepting such obligations, You may act only on Your own
+behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or
+claims asserted against, such Contributor by reason of your accepting any such warranty or
+additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2020 link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
+compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]
+of the License.
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is
+distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied. See the License for the specific language governing permissions and limitations under the
+License.

data/README.adoc

@@ -0,0 +1,207 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+= Rubysmith
+
+[link=http://badge.fury.io/rb/rubysmith]
+image::https://badge.fury.io/rb/rubysmith.svg[Gem Version]
+[link=https://circleci.com/gh/bkuhlmann/rubysmith]
+image::https://circleci.com/gh/bkuhlmann/rubysmith.svg?style=svg[Circle CI Status]
+
+A command line interface for smithing Ruby projects.
+
+toc::[]
+
+== Features
+
+* Builds a Ruby project skeleton for custom design and development.
+* Uses link:https://www.alchemists.io/projects/refinements[Refinements] Ruby core library enhancements.
+* Uses link:https://www.alchemists.io/projects/runcom[Runcom] for resource configuration management.
+* Uses link:https://www.alchemists.io/projects/pragmater[Pragmater] for Ruby source pragma directives.
+* Supports link:https://github.com/rubysec/bundler-audit[Bundler Audit].
+* Supports link:https://git-scm.com[Git]
+* Supports link:https://www.alchemists.io/projects/git-lint[Git Lint].
+* Supports link:https://github.com/guard/guard[Guard].
+* Supports link:http://pryrepl.org[Pry].
+* Supports link:https://github.com/troessner/reek[Reek].
+* Supports link:https://rspec.info[RSpec].
+* Supports link:https://github.com/rubocop-hq/rubocop[Rubocop].
+* Supports link:https://github.com/rubocop-hq/rubocop-rspec[Rubocop RSpec].
+* Supports link:https://github.com/simplecov-ruby/simplecov[SimpleCov].
+* Supports common settings and a structured layout for building projects.
+* Provides common documentation:
+** README
+** CHANGES
+** CONTRIBUTING
+** CODE OF CONDUCT
+** LICENSE
+
+== Screencasts
+
+[link=https://www.alchemists.io/screencasts/rubysmith]
+image::https://www.alchemists.io/images/screencasts/rubysmith/cover.svg[Screencast,600,240,role=focal_point]
+
+== Requirements
+
+. A UNIX-based system.
+. link:https://www.ruby-lang.org[Ruby].
+. link:https://rubygems.org[RubyGems].
+. link:https://github.com/bundler/bundler[Bundler].
+
+== Setup
+
+=== Production
+
+To install, run:
+
+[source,bash]
+----
+gem install rubysmith
+----
+
+=== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/rubysmith.git
+cd rubysmith
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
+== Usage
+
+=== Command Line Interface (CLI)
+
+From the command line, type: `rubysmith --help`
+
+....
+USAGE:
+  -v, --version                            Show gem version.
+  -h, --help                               Show this message.
+  -c, --config ACTION                      Manage gem configuration: edit or view.
+  -b, --build NAME [options]               Build new gem.
+
+BUILD OPTIONS:
+      --[no-]bundler-audit                 Add Bundler Audit.
+      --[no-]console                       Add console support.
+      --[no-]documentation                 Add Documentation.
+      --[no-]git                           Add Git.
+      --[no-]git-lint                      Add Git Lint.
+      --[no-]guard                         Add Guard.
+      --[no-]reek                          Add Reek.
+      --[no-]pry                           Add Pry.
+      --[no-]rubocop                       Add Rubocop.
+      --[no-]rspec                         Add RSpec.
+      --[no-]simple_cov                    Add SimpleCov.
+      --[no-]setup                         Add setup support.
+....
+
+=== Configuration
+
+This gem can be configured via a global configuration:
+
+....
+$HOME/.config/rubysmith/configuration.yml
+....
+
+It can also be configured via link:https://www.alchemists.io/projects/xdg[XDG] environment
+variables.
+
+The default configuration is as follows:
+
+[source,yaml]
+----
+:author:
+  :name:
+  :email:
+  :url:
+:documentation:
+  :format: "md"
+  :license: "mit"
+:build:
+  :bundler_audit: true
+  :console: true
+  :documentation: true
+  :git: true
+  :git_lint: true
+  :guard: true
+  :pry: true
+  :reek: true
+  :rspec: true
+  :rubocop: true
+  :setup: true
+  :simple_cov: true
+:builders:
+  :pragmater:
+    :comments:
+      - "# frozen_string_literal: true"
+    :includes:
+      - "**/*.rb"
+      - "**/*bin/console"
+      - "**/*bin/guard"
+      - "**/*bin/rubocop"
+      - "**/*Gemfile"
+      - "**/*Guardfile"
+      - "**/*Rakefile"
+----
+
+Feel free to take this default configuration, modify, and save as your own custom
+`configuration.yml`.
+
+=== Console
+
+To use the IRB console to invesitage and/or experiment with all project objects, run:
+
+[source,bash]
+----
+bin/console
+----
+
+== Tests
+
+To test, run:
+
+[source,bash]
+----
+bundle exec rake
+----
+
+== Versioning
+
+Read link:https://semver.org[Semantic Versioning] for details. Briefly, it means:
+
+* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+* Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+* Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+
+== Code of Conduct
+
+Please note that this project is released with a link:CODE_OF_CONDUCT.adoc[CODE OF CONDUCT]. By
+participating in this project you agree to abide by its terms.
+
+== Contributions
+
+Read link:CONTRIBUTING.adoc[CONTRIBUTING] for details.
+
+== License
+
+Read link:LICENSE.adoc[LICENSE] for details.
+
+== History
+
+Read link:CHANGES.adoc[CHANGES] for details.
+Built with link:https://www.alchemists.io/projects/gemsmith[Gemsmith].
+
+== Credits
+
+Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

data/bin/rubysmith

@@ -0,0 +1,11 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+# TODO: Remove once the Pattern Matching feature is fully supported.
+Warning[:experimental] = false
+
+require "rubysmith"
+require "rubysmith/cli/shell"
+
+Process.setproctitle Rubysmith::Identity::VERSION_LABEL
+Rubysmith::CLI::Shell.new.call ARGV

data/lib/rubysmith.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "rubysmith/identity"
+require "rubysmith/pathway"
+require "rubysmith/realm"
+require "rubysmith/renderers/namespace"
+require "rubysmith/renderers/erb"
+require "rubysmith/text/inserter"
+require "rubysmith/builder"
+require "rubysmith/builders/core"
+require "rubysmith/builders/documentation"
+require "rubysmith/builders/git/setup"
+require "rubysmith/builders/git/commit"
+require "rubysmith/builders/bundler"
+require "rubysmith/builders/rake"
+require "rubysmith/builders/console"
+require "rubysmith/builders/setup"
+require "rubysmith/builders/guard"
+require "rubysmith/builders/reek"
+require "rubysmith/builders/rspec/context"
+require "rubysmith/builders/rspec/helper"
+require "rubysmith/builders/pragma"
+require "rubysmith/builders/rubocop"
+require "rubysmith/cli/parsers/core"
+require "rubysmith/cli/parsers/build"
+require "rubysmith/cli/parsers/assembler"
+require "rubysmith/cli/processors/config"
+require "rubysmith/cli/processors/build"
+require "rubysmith/cli/configuration"
+require "rubysmith/cli/shell"

data/lib/rubysmith/builder.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require "refinements/pathnames"
+require "open3"
+require "logger"
+
+module Rubysmith
+  # :reek:TooManyMethods
+  # rubocop:disable Metrics/ClassLength
+  class Builder
+    using Refinements::Pathnames
+
+    LOGGER = Logger.new(
+      STDOUT,
+      formatter: ->(severity, _at, _program, message) { "#{severity} #{message}\n" }
+    )
+
+    HELPERS = {
+      inserter: Text::Inserter,
+      renderer: Renderers::ERB,
+      kernel: Open3,
+      logger: LOGGER
+    }.freeze
+
+    def self.call realm, helpers: HELPERS
+      new realm, helpers: helpers
+    end
+
+    def initialize realm, helpers: HELPERS
+      @realm = realm
+      @helpers = helpers
+    end
+
+    def append content
+      logger.info "Appending: #{relative_build_path}"
+      build_path.rewrite { |body| body + content }
+      self
+    end
+
+    def delete
+      logger.info "Deleting: #{relative_build_path}"
+      build_path.delete
+      self
+    end
+
+    def insert_before pattern, content
+      logger.info "Inserting content before pattern in: #{relative_build_path}"
+      build_path.write inserter.new(build_path.readlines, :before).call(content, pattern).join
+      self
+    end
+
+    def insert_after pattern, content
+      logger.info "Inserting content after pattern in: #{relative_build_path}"
+      build_path.write inserter.new(build_path.readlines, :after).call(content, pattern).join
+      self
+    end
+
+    def permit mode
+      logger.info "Changing permissions for: #{relative_build_path}"
+      build_path.chmod mode
+      self
+    end
+
+    def prepend content
+      logger.info "Prepending content to: #{relative_build_path}"
+      build_path.rewrite { |body| content + body }
+      self
+    end
+
+    def rename name
+      logger.info "Renaming: #{build_path.basename} to #{name}"
+      build_path.rename build_path.parent.join(name)
+      self
+    end
+
+    def render
+      logger.info "Rendering: #{relative_build_path}"
+
+      pathway.start_path.read.then do |content|
+        build_path.make_ancestors.write renderer.call(content)
+      end
+
+      self
+    end
+
+    def replace pattern, content
+      logger.info "Replacing content for patterns in: #{relative_build_path}"
+      build_path.rewrite { |body| body.gsub pattern, content }
+      self
+    end
+
+    def run *command
+      logger.info "Running: #{command}"
+      execute(*command)
+      self
+    rescue StandardError => error
+      logger.error error and self
+    end
+
+    def touch
+      logger.info "Touching: #{relative_build_path}"
+      build_path.make_ancestors.touch
+      self
+    end
+
+    private
+
+    attr_reader :realm, :helpers
+
+    def execute *command
+      kernel.capture2e(*command).then do |result, status|
+        logger.error result unless status.success?
+      end
+    end
+
+    def inserter
+      helpers.fetch __method__
+    end
+
+    def renderer
+      helpers.fetch(__method__).new realm
+    end
+
+    def kernel
+      helpers.fetch __method__
+    end
+
+    def logger
+      helpers.fetch __method__
+    end
+
+    def relative_build_path
+      build_path.relative_path_from realm.build_root
+    end
+
+    def build_path
+      pathway.end_path.gsub("%project_name%", realm.project_name).sub(".erb", "")
+    end
+
+    def pathway
+      realm.to_pathway
+    end
+  end
+  # rubocop:enable Metrics/ClassLength
+end