pragmater 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e3cd60cb96e801aa4fd3cc4e1c6598d2298eb8b
+  data.tar.gz: f518b806aafe3e671c97651d739b59c81312fce5
+SHA512:
+  metadata.gz: 714d74c9f14f6a301325e61e662388a2a780f98589f858b73f6a4080ca9afe77a5f8f5db6d56e86e92b7d75aca48efaa9a710b94d83d6ab5218b6529c03b15bf
+  data.tar.gz: fe04dadb9f1324af93dcaacf37bfdb50c9c8d8945f3f183170c1db3974f86c5b9d42b99d205383b331a55f95bd7d468180003e3d3ab6acc9d872d4c239b3f320

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2015 [Alchemists](https://www.alchemists.io).
+
+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,120 @@
+# Pragmater
+
+[![Gem Version](https://badge.fury.io/rb/pragmater.svg)](http://badge.fury.io/rb/pragmater)
+[![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/pragmater.svg)](https://codeclimate.com/github/bkuhlmann/pragmater)
+[![Code Climate Coverage](https://codeclimate.com/github/bkuhlmann/pragmater/coverage.svg)](https://codeclimate.com/github/bkuhlmann/pragmater)
+[![Gemnasium Status](https://gemnasium.com/bkuhlmann/pragmater.svg)](https://gemnasium.com/bkuhlmann/pragmater)
+[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/pragmater.svg)](https://travis-ci.org/bkuhlmann/pragmater)
+[![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)
+
+A command line interface for adding [directive pragma](https://en.wikipedia.org/wiki/Directive_(programming)) comments
+(a.k.a. *magic comments*) to source files. Examples:
+
+    #! /usr/bin/ruby
+    # frozen_string_literal: true
+    # encoding: UTF-8
+
+With the release of [Ruby 2.3.0](https://www.ruby-lang.org/en/news/2015/12/25/ruby-2-3-0-released), support for frozen
+strings are now supported via a pragma comment. This gems provides a easy way to add pragma comments to single or
+multiple Ruby source files in order to benefit from improved memory and concurrency performance.
+
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+# Table of Contents
+
+- [Features](#features)
+- [Requirements](#requirements)
+- [Setup](#setup)
+- [Usage](#usage)
+  - [Command Line Interface (CLI)](#command-line-interface-cli)
+- [Tests](#tests)
+- [Versioning](#versioning)
+- [Code of Conduct](#code-of-conduct)
+- [Contributions](#contributions)
+- [License](#license)
+- [History](#history)
+- [Credits](#credits)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
+
+# Features
+
+- Supports adding a pragma comment or multiple pragma comments to single or multiple source files.
+- Supports removing a pragma comment or multiple pragma comments from single or multiple source files.
+- Supports whitelist filtering. Defaults to `*.rb` and `*.rake` files.
+- Ensures duplicate pragma comments never exist.
+- Ensures pragma commments are always properly formatted.
+
+# Requirements
+
+0. [MRI 2.3.x](https://www.ruby-lang.org)
+
+# Setup
+
+For a secure install, type the following (recommended):
+
+    gem cert --add <(curl -Ls https://www.my-website.com/gem-public.pem)
+    gem install pragmater --trust-policy MediumSecurity
+
+NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while
+allowing the installation of unsigned dependencies since they are beyond the scope of this gem.
+
+For an insecure install, type the following (not recommended):
+
+    gem install pragmater
+
+# Usage
+
+## Command Line Interface (CLI)
+
+From the command line, type: `pragmater help`
+
+    pragmater -a, [--add=ADD]        # Add pragma comments to source file(s).
+    pragmater -e, [--edit]           # Edit Pragmater settings in default editor.
+    pragmater -h, [--help=HELP]      # Show this message or get help for a command.
+    pragmater -r, [--remove=REMOVE]  # Remove pragma comments from source file(s).
+    pragmater -v, [--version]        # Show Pragmater version.
+
+Both the `--add` and `--remove` options provide the ability to supply specific pragma comments and/or whitelisted file
+extensions:
+
+    -c, [--comments=one two three]    # Pragma comments
+    -e, [--extensions=one two three]  # File extension whitelist
+                                      # Default: [".rb", ".rake"]
+
+# Tests
+
+To test, run:
+
+    bundle exec rake
+
+# Versioning
+
+Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
+
+- Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
+- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+
+# Code of Conduct
+
+Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By participating in this project
+you agree to abide by its terms.
+
+# Contributions
+
+Read [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+# License
+
+Copyright (c) 2015 [Alchemists](https://www.alchemists.io).
+Read the [LICENSE](LICENSE.md) for details.
+
+# History
+
+Read the [CHANGELOG](CHANGELOG.md) for details.
+Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
+
+# Credits
+
+Developed by [Brooke Kuhlmann](https://www.alchemists.io) at [Alchemists](https://www.alchemists.io).

data/bin/pragmater

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby
+# frozen_string_literal: true
+
+require "pragmater"
+require "pragmater/cli"
+require "pragmater/identity"
+
+Process.setproctitle Pragmater::Identity.version_label
+Pragmater::CLI.start

data/lib/pragmater/cli.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "pathname"
+require "thor"
+require "thor/actions"
+require "thor_plus/actions"
+
+module Pragmater
+  # The Command Line Interface (CLI) for the gem.
+  class CLI < Thor
+    include Thor::Actions
+    include ThorPlus::Actions
+
+    package_name Pragmater::Identity.version_label
+
+    def initialize args = [], options = {}, config = {}
+      super args, options, config
+    end
+
+    desc "-a, [--add=ADD]", "Add pragma comments to source file(s)."
+    map %w(-a --add) => :add
+    method_option :comments, aliases: "-c", desc: "Pragma comments", type: :array, default: []
+    method_option :extensions, aliases: "-e", desc: "File extension whitelist", type: :array, default: [".rb", ".rake"]
+    def add path
+      write path, options[:comments], options[:extensions], :add
+    end
+
+    desc "-r, [--remove=REMOVE]", "Remove pragma comments from source file(s)."
+    map %w(-r --remove) => :remove
+    method_option :comments, aliases: "-c", desc: "Pragma comments", type: :array, default: []
+    method_option :extensions, aliases: "-e", desc: "File extension whitelist", type: :array, default: [".rb", ".rake"]
+    def remove path
+      write path, options[:comments], options[:extensions], :remove
+    end
+
+    desc "-e, [--edit]", "Edit #{Pragmater::Identity.label} settings in default editor."
+    map %w(-e --edit) => :edit
+    def edit
+      resource_file = File.join ENV["HOME"], Pragmater::Identity.file_name
+      info "Editing: #{resource_file}..."
+      `#{editor} #{resource_file}`
+    end
+
+    desc "-v, [--version]", "Show #{Pragmater::Identity.label} version."
+    map %w(-v --version) => :version
+    def version
+      say Pragmater::Identity.version_label
+    end
+
+    desc "-h, [--help=HELP]", "Show this message or get help for a command."
+    map %w(-h --help) => :help
+    def help task = nil
+      say && super
+    end
+
+    private
+
+    def update_file path, comments, action
+      Writer.new(path, comments).public_send action
+      say "Updated: #{path}."
+    end
+
+    def write path, comments, extensions, action
+      pathname = Pathname path
+
+      case
+        when pathname.file?
+          update_file pathname, comments, action
+        when pathname.directory?
+          files = Pathname.glob %(#{pathname}/**/*{#{extensions.join ","}})
+          files.each { |file_path| update_file file_path, comments, action }
+        else
+          error "Invalid path: #{path}."
+      end
+    end
+  end
+end

data/lib/pragmater/commenter.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Pragmater
+  # Handles pragma comments.
+  class Commenter
+    def initialize older, newer, formatter: Formatter
+      @formatter = formatter
+      @older = format older
+      @newer = format newer
+    end
+
+    def add
+      older | newer
+    end
+
+    def remove
+      older - (older & newer)
+    end
+
+    private
+
+    attr_reader :older, :newer, :formatter
+
+    def format comments
+      Array(comments).map { |comment| formatter.new(comment).format }
+    end
+  end
+end

data/lib/pragmater/formatter.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Pragmater
+  # Formats pragma comments in a consistent manner.
+  class Formatter
+    def self.shebang_format
+      /
+        \A       # Start of line.
+        \#       # Start of comment.
+        \!       # Bang.
+        \s?      # Space - optional.
+        \/.*ruby # Absolute path to Ruby program.
+        \Z       # End of line.
+      /x
+    end
+
+    def self.pragma_format
+      /
+        \A  # Start of line.
+        \#  # Start of comment.
+        \s? # Space - optional.
+        \w+ # Key - 1 or more word characters only.
+        \:  # Key and value delimiter.
+        \s? # Space - optional.
+        .+  # Value - 1 or more characters.
+        \Z  # End of line.
+      /x
+    end
+
+    def initialize comment
+      @comment = comment
+    end
+
+    def format_shebang
+      return comment unless comment =~ self.class.shebang_format
+
+      _, path = comment.split "!"
+      "#! #{path.strip}"
+    end
+
+    def format_pragma
+      return comment unless comment =~ self.class.pragma_format
+
+      key, value = comment.split ":"
+      "# #{key.gsub(/\#\s?/, "")}: #{value.strip}"
+    end
+
+    def format
+      case comment
+        when self.class.shebang_format then format_shebang
+        when self.class.pragma_format then format_pragma
+        else comment
+      end
+    end
+
+    private
+
+    attr_reader :comment
+  end
+end

data/lib/pragmater/identity.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Pragmater
+  # Gem identity information.
+  module Identity
+    def self.name
+      "pragmater"
+    end
+
+    def self.label
+      "Pragmater"
+    end
+
+    def self.version
+      "0.1.0"
+    end
+
+    def self.version_label
+      "#{label} #{version}"
+    end
+
+    def self.file_name
+      ".#{name}rc"
+    end
+  end
+end

data/lib/pragmater/writer.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Pragmater
+  # Writes formatted pragma comments to source file.
+  class Writer
+    def initialize file_path, new_comments, formatter: Formatter, commenter: Commenter
+      @file_path = file_path
+      @file_lines = File.open(file_path).to_a
+      @formatter = formatter
+      @commenter = commenter
+      @old_comments = file_comments
+      @new_comments = new_comments
+    end
+
+    def add
+      write { (format(commenter.new(old_comments, new_comments).add) + file_lines_without_comments).join }
+    end
+
+    def remove
+      write { (format(commenter.new(old_comments, new_comments).remove) + file_lines_without_comments).join }
+    end
+
+    private
+
+    attr_reader :file_path, :file_lines, :new_comments, :old_comments, :formatter, :commenter
+
+    def file_comments
+      file_lines.select { |line| line =~ formatter.shebang_format || line =~ formatter.pragma_format }
+    end
+
+    def file_lines_without_comments
+      file_lines.reject { |line| old_comments.include? line }
+    end
+
+    def format lines
+      lines.map { |line| "#{line}\n" }
+    end
+
+    def write
+      File.open(file_path, "w") { |file| file.write yield }
+    end
+  end
+end

data/lib/pragmater.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "pragmater/commenter"
+require "pragmater/formatter"
+require "pragmater/identity"
+require "pragmater/writer"

data/lib/tasks/rspec.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError => error
+  puts error.message
+end

data/lib/tasks/rubocop.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError => error
+  puts error.message
+end

metadata

@@ -0,0 +1,310 @@
+--- !ruby/object:Gem::Specification
+name: pragmater
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brooke Kuhlmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor_plus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gemsmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-state
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A command line interface for adding pragma comments to source files.
+email:
+- brooke@alchemists.io
+executables:
+- pragmater
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+files:
+- LICENSE.md
+- README.md
+- bin/pragmater
+- lib/pragmater.rb
+- lib/pragmater/cli.rb
+- lib/pragmater/commenter.rb
+- lib/pragmater/formatter.rb
+- lib/pragmater/identity.rb
+- lib/pragmater/writer.rb
+- lib/tasks/rspec.rake
+- lib/tasks/rubocop.rake
+homepage: https://github.com/bkuhlmann/pragmater
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A command line interface for adding pragma comments to source files.
+test_files: []