rubysmith 0.1.0

data/lib/rubysmith/pathway.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "refinements/pathnames"
+
+module Rubysmith
+  # Represents a pathway which has source start and destination end.
+  Pathway = Struct.new :start_root, :start_path, :end_root, keyword_init: true do
+    using Refinements::Pathnames
+
+    def initialize *arguments
+      super
+      each_pair { |key, value| self[key] = Pathname value }
+      self[:start_path] = start_path.absolute? ? start_path : start_root.join(start_path)
+      freeze
+    end
+
+    def with attributes
+      self.class.new to_h.merge(attributes)
+    end
+
+    def end_path
+      end_root.join from_parent, start_path.basename
+    end
+
+    def partial?
+      start_path.basename.fnmatch? "_*"
+    end
+
+    private
+
+    def from_parent
+      return end_root.join start_path.parent if start_path.relative?
+
+      start_path.relative_parent start_root
+    end
+  end
+end

data/lib/rubysmith/realm.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "refinements/strings"
+
+module Rubysmith
+  REALM_KEYS = %i[
+    config
+    template_root
+    template_path
+    build_root
+    project_name
+    author_name
+    author_email
+    author_url
+    now
+    documentation_format
+    documentation_license
+    build_bundler_audit
+    build_console
+    build_documentation
+    build_git
+    build_git_lint
+    build_guard
+    build_pry
+    build_reek
+    build_rspec
+    build_rubocop
+    build_setup
+    build_simple_cov
+    builders_pragmater_comments
+    builders_pragmater_includes
+    version
+    help
+  ].freeze
+
+  # Represents the common context in which all builders and templates operate in.
+  Realm = Struct.new(*REALM_KEYS, keyword_init: true) do
+    using Refinements::Strings
+
+    def initialize *arguments
+      super
+
+      self[:template_root] ||= Pathname(__dir__).join("templates").expand_path
+      self[:build_root] ||= Pathname.pwd
+      freeze
+    end
+
+    def with attributes
+      self.class.new to_h.merge(attributes)
+    end
+
+    def project_label
+      project_name.titleize
+    end
+
+    def project_class
+      project_name.camelcase
+    end
+
+    def project_root
+      build_root.join project_name
+    end
+
+    def to_pathway
+      Pathway[start_root: template_root, start_path: template_path, end_root: build_root]
+    end
+  end
+end

data/lib/rubysmith/renderers/erb.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "erb"
+
+module Rubysmith
+  module Renderers
+    # Renders ERB templates as fully functional files.
+    class ERB
+      def initialize realm, scope: Renderers::Namespace.new(realm.project_class), client: ::ERB
+        @realm = realm
+        @scope = scope
+        @client = client
+      end
+
+      def call content
+        client.new(content, trim_mode: "<>", eoutvar: "@buffer").result binding
+      end
+
+      private
+
+      attr_accessor :buffer
+      attr_reader :realm, :scope, :client
+
+      def namespace
+        self.buffer = scope.call yield
+      end
+    end
+  end
+end

data/lib/rubysmith/renderers/namespace.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "refinements/strings"
+
+module Rubysmith
+  module Renderers
+    # Renders single or multiple modules with correct, two-space indentation for templates.
+    class Namespace
+      using Refinements::Strings
+
+      def initialize namespace
+        @namespace = namespace
+        @modules = namespace.split "::"
+        @depth = namespace.scan("::").length
+      end
+
+      def call content
+        "#{prefix}#{body content}#{suffix.chomp}"
+      end
+
+      private
+
+      attr_reader :namespace, :modules, :depth
+
+      def prefix
+        modules.each.with_index.reduce "" do |snippet, (module_name, index)|
+          %(#{snippet}#{"module".indent index} #{module_name}\n)
+        end
+      end
+
+      # :reek:FeatureEnvy
+      def body content
+        content.lstrip.split("\n").reduce "" do |snippet, line|
+          next "#{snippet}\n" if line.blank?
+
+          "#{snippet}#{line.gsub(/^\s{2}/, "").indent depth + 1}\n"
+        end
+      end
+
+      def suffix
+        modules.each.with_index.reduce "" do |snippet, (_, index)|
+          %(#{snippet}#{"end".indent depth - index}\n)
+        end
+      end
+    end
+  end
+end

data/lib/rubysmith/templates/%project_name%/.reek.yml.erb

@@ -0,0 +1,3 @@
+exclude_paths:
+  - tmp
+  - vendor

data/lib/rubysmith/templates/%project_name%/.rubocop.yml.erb

@@ -0,0 +1,7 @@
+inherit_from:
+  - https://raw.githubusercontent.com/bkuhlmann/code_quality/master/configurations/rubocop/ruby.yml
+  - https://raw.githubusercontent.com/bkuhlmann/code_quality/master/configurations/rubocop/rake.yml
+  - https://raw.githubusercontent.com/bkuhlmann/code_quality/master/configurations/rubocop/performance.yml
+<% if realm.build_rspec %>
+  - https://raw.githubusercontent.com/bkuhlmann/code_quality/master/configurations/rubocop/rspec.yml
+<% end %>

data/lib/rubysmith/templates/%project_name%/.ruby-version.erb

@@ -0,0 +1 @@
+<%= RUBY_VERSION %>

data/lib/rubysmith/templates/%project_name%/CHANGES.adoc.erb

@@ -0,0 +1,5 @@
+= Changes
+
+== 0.1.0 (<%= realm.now.strftime "%Y-%m-%d" %>)
+
+* Added initial implementation.

data/lib/rubysmith/templates/%project_name%/CHANGES.md.erb

@@ -0,0 +1,5 @@
+# Changes
+
+## 0.1.0 (<%= realm.now.strftime "%Y-%m-%d" %>)
+
+- Added initial implementation.

data/lib/rubysmith/templates/%project_name%/CODE_OF_CONDUCT.adoc.erb

@@ -0,0 +1,114 @@
+= Contributor Covenant Code of Conduct
+
+== Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a
+harassment-free experience for everyone, regardless of age, body size, visible or invisible
+disability, ethnicity, sex characteristics, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and
+healthy community.
+
+== Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the
+  experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their
+  explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+== Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior
+and will take appropriate and fair corrective action in response to any behavior that they deem
+inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits,
+code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and
+will communicate reasons for moderation decisions when appropriate.
+
+== Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is
+officially representing the community in public spaces. Examples of representing our community
+include using an official e-mail address, posting via an official social media account, or acting as
+an appointed representative at an online or offline event.
+
+== Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community
+leaders responsible for enforcement at link:mailto:<%= realm.author_email %>?subject=Conduct[<%=
+realm.author_name %>].
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any
+incident.
+
+== Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for
+any action they deem in violation of this Code of Conduct:
+
+=== 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or
+unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the
+nature of the violation and an explanation of why the behavior was inappropriate. A public apology
+may be requested.
+
+=== 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people
+involved, including unsolicited interaction with those enforcing the Code of Conduct, for a
+specified period of time. This includes avoiding interactions in community spaces as well as
+external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+=== 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate
+behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the
+community for a specified period of time. No public or private interaction with the people involved,
+including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this
+period. Violating these terms may lead to a permanent ban.
+
+=== 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including
+sustained inappropriate behavior,  harassment of an individual, or aggression toward or
+disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+== Attribution
+
+This Code of Conduct is adapted from the
+link:https://www.contributor-covenant.org/version/2/0/code_of_conduct.html[Contributor Covenant,
+Version 2.0].
+
+Community Impact Guidelines were inspired by link:https://github.com/mozilla/diversity[Mozilla's
+code of conduct enforcement ladder].
+
+For answers to common questions about this code of conduct, see the
+link:https://www.contributor-covenant.org/faq[FAQ]. Translations are available
+link:https://www.contributor-covenant.org/translations[here].

data/lib/rubysmith/templates/%project_name%/CODE_OF_CONDUCT.md.erb

@@ -0,0 +1,115 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a
+harassment-free experience for everyone, regardless of age, body size, visible or invisible
+disability, ethnicity, sex characteristics, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and
+healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the
+  experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their
+  explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior
+and will take appropriate and fair corrective action in response to any behavior that they deem
+inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits,
+code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and
+will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is
+officially representing the community in public spaces. Examples of representing our community
+include using an official e-mail address, posting via an official social media account, or acting as
+an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community
+leaders responsible for enforcement at [<%= realm.author_name %>](mailto:<%= realm.author_email
+%>?subject=Conduct).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any
+incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for
+any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or
+unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the
+nature of the violation and an explanation of why the behavior was inappropriate. A public apology
+may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people
+involved, including unsolicited interaction with those enforcing the Code of Conduct, for a
+specified period of time. This includes avoiding interactions in community spaces as well as
+external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the
+community for a specified period of time. No public or private interaction with the people involved,
+including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this
+period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including
+sustained inappropriate behavior,  harassment of an individual, or aggression toward or
+disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant, Version
+2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html)
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement
+ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the
+[FAQ](https://www.contributor-covenant.org/faq). Translations are available
+[here](https://www.contributor-covenant.org/translations).
+