geny 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6add91eb73cf3bca67eef2bb86d8ab4e4afc06e6
+  data.tar.gz: 60637a783f679b4a0b473e59bd92a96a94b48890
+SHA512:
+  metadata.gz: 74318c4fa54b0ed4337f3e6b0fb9f4ed5700dd6f49ecc98b881869f2cd7edf025f876e2192dff3df5a51c50e8f6ffa29be0584570cd64db9dc52c116efb09f70
+  data.tar.gz: 66f631fa5bec33843def8f4bfc57fb5f3c774a20e78d376864a3e107a5cf491460fe6691e644747e3ecd95fd7464cd48a20b488a5ba765fcf4d800535b4a7ba4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.2

data/.yardopts

@@ -0,0 +1,6 @@
+--output-dir=doc/api
+--embed-mixins
+--protected
+--no-private
+--markup-provider=redcarpet
+--markup=markdown

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at raymondzane@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in geny.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    geny (0.1.0)
+      argy (~> 0.2.2)
+      pastel (~> 0.7.3)
+      tty-file (~> 0.8.0)
+      tty-prompt (~> 0.20.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    argy (0.2.2)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    equatable (0.6.1)
+    json (2.3.0)
+    necromancer (0.5.1)
+    pastel (0.7.3)
+      equatable (~> 0.6)
+      tty-color (~> 0.5)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    tty-color (0.5.0)
+    tty-cursor (0.7.0)
+    tty-file (0.8.0)
+      diff-lcs (~> 1.3)
+      pastel (~> 0.7.2)
+      tty-prompt (~> 0.18)
+    tty-prompt (0.20.0)
+      necromancer (~> 0.5.0)
+      pastel (~> 0.7.0)
+      tty-reader (~> 0.7.0)
+    tty-reader (0.7.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.7)
+      wisper (~> 2.0.0)
+    tty-screen (0.7.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  geny!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.17.1)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ray Zane
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# Geny [![Build Status](https://travis-ci.org/rzane/geny.svg?branch=master)](https://travis-ci.org/rzane/geny)
+
+A tool for building code generators.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'geny'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geny
+
+## Usage
+
+You are tired of writing the boilerplate for new React components. Let's solve that.
+
+First, let's create a template at `.geny/react/component/templates/component.erb`:
+
+```javascript
+import React from "react";
+
+export const <%= name %> = props => {
+  return <h1><%= name ></h1>
+}
+```
+
+Next, we'll define our generator at `.geny/react/component/generator.rb`:
+
+```ruby
+parse do
+  description "generate a React component"
+  usage "geny react:component [NAME]"
+  argument :name, required: true, desc: "component name"
+end
+
+invoke do
+  templates.copy "component.erb", "src/components/#{name}.js"
+end
+```
+
+Awesome. Run it:
+
+    $ geny react:component Logo
+            create  src/components/Logo.js
+
+Obviously, this is a simple example. But Geny comes with a lot of tools to help you build really great code generators with minimal effort.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rzane/geny. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Geny project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rzane/geny/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "geny"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/geny

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "geny/cli"
+
+cli = Geny::CLI.new
+
+begin
+  cli.run(ARGV)
+rescue Geny::Error, Argy::Error => error
+  cli.abort!(error.message)
+end

data/geny.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "geny/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "geny"
+  spec.version       = Geny::VERSION
+  spec.authors       = ["Ray Zane"]
+  spec.email         = ["raymondzane@gmail.com"]
+
+  spec.summary       = %q{The only tool you need to build a code generator.}
+  spec.homepage      = "https://github.com/rzane/geny"
+  spec.license       = "MIT"
+
+  spec.metadata["source_code_uri"] = "https://github.com/rzane/geny"
+  spec.metadata["documentation_uri"] = "https://rubydoc.info/github/rzane/geny"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "argy", "~> 0.2.2"
+  spec.add_dependency "pastel", "~> 0.7.3"
+  spec.add_dependency "tty-file", "~> 0.8.0"
+  spec.add_dependency "tty-prompt", "~> 0.20.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.17.1"
+end

data/lib/generators/new/generator.rb

@@ -0,0 +1,15 @@
+parse do
+  usage "geny new [NAME]"
+  description "create a new generator"
+  argument :name, desc: "name for your generator", required: true
+end
+
+invoke do
+  templates.copy "generator.rb.erb", generator_path
+end
+
+helpers do
+  def generator_path
+    File.join(".geny", *name.split(":"), Geny::Command::FILENAME)
+  end
+end

data/lib/generators/new/templates/generator.rb.erb

@@ -0,0 +1,14 @@
+parse do
+  description "a really useful generator"
+  usage "geny <%= name %> [MESSAGE]"
+  argument :message, required: true, desc: "the message to print"
+  option :loud, type: :boolean, aliases: ["-l"], desc: "uppercase"
+end
+
+invoke do
+  if loud?
+    ui.say message.upcase
+  else
+    ui.say message
+  end
+end

data/lib/geny/actions/files.rb

@@ -0,0 +1,96 @@
+require "tty-file"
+
+module Geny
+  module Actions
+    # Utilities for manipulating files.
+    # @see https://rubydoc.info/github/piotrmurach/tty-file/master/TTY/File TTY::File
+    class Files
+      # Create a file
+      #
+      # @example
+      #   files.create("test.txt")
+      #   files.create("test.txt", "hello!")
+      #   files.remove("test.txt", force: true)
+      def create(*args)
+        TTY::File.create_file(*args)
+      end
+
+      # Create a directory recursively
+      #
+      # @example
+      #   files.create_dir("app/controllers")
+      def create_dir(*args)
+        TTY::File.create_dir(*args)
+      end
+
+      # Remove a file
+      #
+      # @example
+      #   files.remove("tmp")
+      #   files.remove("tmp", force: true)
+      def remove(*args)
+        TTY::File.remove_file(*args)
+      end
+
+      # Add a line to the top of a file
+      #
+      # @example
+      #   files.prepend("Gemfile", "gem 'geny'")
+      def prepend(*args)
+        TTY::File.safe_prepend_to_file(*args)
+      end
+
+      # Add a line to the bottom of a file
+      #
+      # @example
+      #   files.append("Gemfile", "gem 'geny'")
+      def append(*args)
+        TTY::File.safe_append_to_file(*args)
+      end
+
+      # Replace content in a file
+      #
+      # @example
+      #   files.replace("Gemfile", /foo/, "bar")
+      def replace(*args)
+        TTY::File.replace_in_file(*args)
+      end
+
+      # Insert a line before a matching line in a file
+      #
+      # @example
+      #   files.insert_before("Gemfile", /gem "rails"/, "gem 'geny'")
+      def insert_before(path, pattern, content, **opts)
+        opts = {before: pattern, **opts}
+        TTY::File.safe_inject_into_file(path, content, opts)
+      end
+
+      # Insert a line after a matching line in a file
+      #
+      # @example
+      #   files.insert_after("Gemfile", /gem "rails"\n/, "gem 'geny'")
+      def insert_after(path, pattern, content, **opts)
+        opts = {after: pattern, **opts}
+        TTY::File.safe_inject_into_file(path, content, opts)
+      end
+
+      # Change the permissions of a file
+      #
+      # @example
+      #   files.chmod("bin/test", "+x")
+      def chmod(path, mode, *args)
+        TTY::File.chmod(path, coerce_mode(mode), *args)
+      end
+
+      private
+
+      def coerce_mode(mode)
+        if mode.respond_to?(:match?) && mode.match?(/^[+-]/)
+          "a#{mode}"
+        else
+          mode
+        end
+      end
+    end
+  end
+end

data/lib/geny/actions/git.rb

@@ -0,0 +1,53 @@
+require "geny/error"
+
+module Geny
+  module Actions
+    # Utilities for interacting with a git repo
+    class Git
+      # Create a new Git
+      # @param shell [Shell]
+      def initialize(shell:)
+        @shell = shell
+      end
+
+      # Initialize a new git repo
+      # @raise [ExitError]
+      #
+      # @example
+      #   git.init
+      def init(**opts)
+        @shell.run("git", "init", out: File::NULL, **opts)
+      end
+
+      # Stage files to be committed
+      # @param files [Array<String>]
+      # @raise [ExitError]
+      #
+      # @example
+      #   git.add
+      #   git.add files: ["Gemfile"]
+      def add(files: ["."], **opts)
+        @shell.run("git", "add", *files, out: File::NULL, **opts)
+      end
+
+      # Commit staged files
+      # @param message [String]
+      # @raise [ExitError]
+      #
+      # @example
+      #   git.commit message: "First commit"
+      def commit(message:, **opts)
+        @shell.run("git", "commit", "-m", message, out: File::NULL, **opts)
+      end
+
+      # Get the path to the current git repo
+      # @raise [ExitError]
+      #
+      # @example
+      #   git.repo_path #=> "/path/to/repo"
+      def repo_path(**opts)
+        @shell.capture("git", "rev-parse", "--show-toplevel", **opts)
+      end
+    end
+  end
+end

data/lib/geny/actions/shell.rb

@@ -0,0 +1,62 @@
+require "open3"
+require "geny/error"
+
+module Geny
+  module Actions
+    # Utilities for executing shell commands
+    class Shell
+      # Create a new shell
+      # @param ui [UI]
+      def initialize(ui:)
+        @ui = ui
+      end
+
+      # Run a shell command and return it's output
+      # @raise [ExitError] when the command exits with a non-zero status
+      # @return [String]
+      #
+      # @example
+      #   shell.capture("echo", "hello") #=> "hello"
+      def capture(*args, **opts)
+        cmd = build_command(*args, **opts)
+        cmd_str = stringify_command(args)
+        out, _err, status = Open3.capture3(*cmd)
+        assert_success!(status, cmd_str)
+        out.chomp
+      rescue Errno::ENOENT
+        raise ExitError.new(command: cmd_str, code: 127)
+      end
+
+      # Run a shell command
+      # @raise [ExitError] when the command exits with a non-zero status
+      #
+      # @example
+      #   shell.capture("echo", "hello") # prints "hello"
+      def run(*args, verbose: true, **opts)
+        cmd = build_command(*args, **opts)
+        cmd_str = stringify_command(args)
+
+        @ui.status("run", cmd_str) if verbose
+
+        Kernel.system(*cmd)
+        assert_success!($?, cmd_str)
+      end
+
+      private
+
+      def build_command(*args, env: nil, **opts)
+        [*env, *args, **opts]
+      end
+
+      def stringify_command(args)
+        args.map { |arg| arg.match?(/\s/) ? arg.inspect : arg }.join(" ")
+      end
+
+      def assert_success!(status, cmd)
+        unless status.success?
+          raise ExitError.new(command: cmd, code: status.exitstatus)
+        end
+      end
+    end
+  end
+end

data/lib/geny/actions/templates.rb

@@ -0,0 +1,68 @@
+require "tty-file"
+require "geny/context/view"
+
+module Geny
+  module Actions
+    # Utilities for rendering and copying templates.
+    # @see https://rubydoc.info/github/piotrmurach/tty-file/master/TTY/File TTY::File
+    class Templates
+      # Creates a new instance
+      # @param root [String] the root path where templates live
+      # @param view [View] a view that exposes locals and helpers
+      def initialize(root:, view:)
+        @root = root
+        @view = view
+      end
+
+      # Copy a template file. The file will be evaluated with ERB.
+      # All command-line options and helper methods are available in
+      # the template.
+      #
+      # @example
+      #   templates.copy("hello.erb", "hello.txt")
+      #   templates.copy("hello.erb", "hello.txt", locals: {name: "world"})
+      def copy(source, *args, **opts)
+        source = expand_path(source)
+        context, opts = build_context(opts)
+        TTY::File.copy_file(source, *args, context: context, **opts)
+      end
+
+      # Copy a template directory. All files will be evaluated with ERB.
+      # All command-line options and helper methods are available in
+      # the template.
+      #
+      # @example
+      #   templates.copy_dir("boilerplate", output)
+      #   templates.copy_dir("boilerplate", output, locals: {name: "world"})
+      def copy_dir(source, *args, **opts)
+        source = expand_path(source)
+        context, opts = build_context(opts)
+        TTY::File.copy_dir(source, *args, context: context, **opts)
+      end
+
+      # Render an ERB template. All command-line options and helper
+      # methods are available in the template.
+      #
+      # @example
+      #   templates.render("hello.erb")
+      #   templates.render("hello.erb", locals: {name: "world"})
+      def render(path, **opts)
+        path = expand_path(path)
+        input = File.binread(path)
+        context, _opts = build_context(opts)
+        erb = ERB.new(input, nil, "-", "@output_buffer")
+        erb.result(context.instance_eval("binding"))
+      end
+
+      private
+
+      def build_context(locals: {}, **opts)
+        [@view.merge(locals), opts]
+      end
+
+      def expand_path(path)
+        File.expand_path(path, @root)
+      end
+    end
+  end
+end