stamper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7260804a0ee8714a348bba3207f9ed391591c74d
+  data.tar.gz: 8597342b0aca99fa0c1b2dde2593d5a06642fa6d
+SHA512:
+  metadata.gz: 99262c5f8b66aa88d89790a594ba42ac3a14f6c42216ab0ccbb578d3c4af60664e076ea00701fd95aae645310f2eeb41cd1a575c17692e1d48685be75b40c4f2
+  data.tar.gz: f9530d1daa881c2bc7646691368a0fd6336ffe9f5292724e161312fd075b4a919274b4bdaec47c67a7d30d63d21af076f851d29901f39e3edfd0f3d8072574f4

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor/bundle

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  Include:
+    - config.ru
+    - bin
+    - lib
+    - Gemfile
+    - Guardfile
+    - Rakefile
+  Exclude:
+    - vendor/**/*
+    - pkg/**/*
+
+ClassLength:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+LineLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+AlignHash:
+  Enabled: false
+
+SpecialGlobalVars:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Renier Morales
+
+MIT License
+
+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,74 @@
+# Stamper
+
+Prepends a blurb of text to any files you specify while respecting a list of
+includes and exclude patterns for maximum flexibility.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stamper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ sudo gem install stamper
+
+## Usage
+
+### CLI
+
+    $ stamper --help
+    Usage: stamper -s STAMPFILE [options]
+
+    Prepends a blurb of text to any files you specify while respecting
+    a list of includes and exclude patterns for maximum flexibility.
+
+    Required:
+        -s, --stamp STAMPFILE            Read the stamp from the specified file.
+
+    Options:
+        -p, --path DIRECTORY             Directory to scan for files. Defaults to current directory.
+        -i, --include 'REGEXP'           Only stamp files that match this pattern. Can be used multiple times.
+                                         Defaults to [".*\\.rb$"].
+        -e, --exclude 'REGEXP'           Do not stamp files that match this pattern. Can be used multiple times.
+                                         Evaluated after includes. Defaults to ["^vendor/"].
+        -r, --respect 'REGEXP'           If the first line in the file matches this pattern,
+                                         place stamp under that line.
+                                         Can be used multiple times. Defaults to ["^#", "^<!"].
+        -d, --dry-run                    Report which files need stamping, but don't make any changes.
+        -q, --quiet                      Do not print any output.
+        -h, --help                       Show this message.
+            --version                    Show version.
+
+**Note**: The `--respect` option is nice for telling _Stamper_ to leave any first
+magic-encoding lines untouched and unmoved. The stamp will be placed under the
+matching line. Will only respect the first line, however, if matched.
+
+**Hint**: You may want to try a few runs with the `--dry-run` option on to see what its doing,
+until you get all the options you want right.
+
+### Programmatic
+
+    require 'stamper'
+
+    Stamper.stamp(
+      stamp: IO.read('copyright.txt'),
+      files: Stamper::DEFAULTS[:files], # This is a glob. Will be fed into Dir.glob()
+      includes: Stamper::DEFAULTS[:includes], # Defaults to ['.*\.rb$']
+      excludes: Stamper::DEFAULTS[:excludes], # Defaults to ['^vendor/']
+      respect_first_marks: Stamper::DEFAULTS[:respect_first_marks], # Defaults to ['^#', '^<!'']
+      dryrun: false,
+      quiet: true
+    )
+
+## Contributing
+
+1. Fork it ( https://github.com/renier/stamper/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+task :rubocop do
+  RuboCop::RakeTask.new
+end

data/bin/stamper

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'stamper/cli'
+
+exit(Stamper.CLI(ARGV) ? 0 : 1)

data/lib/stamper.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+require 'colorize'
+require 'stamper/version'
+
+module Stamper
+  DEFAULTS = {
+    files: '**/*',
+    includes: ['.*\.rb$'],
+    excludes: ['^vendor/'],
+    respect_first_marks: ['^#', '^<!'],
+    dryrun: false,
+    quiet: false
+  }
+
+  def self.stamp(opts)
+    opts = DEFAULTS.merge(opts)
+
+    stamp, files = opts[:stamp], Dir.glob(opts[:files])
+    includes, excludes = opts[:includes], opts[:excludes]
+    respect_first_marks, dryrun = opts[:respect_first_marks], opts[:dryrun]
+    quiet = opts[:quiet]
+
+    if dryrun
+      puts "Checking files that need stamping...\n\n" unless quiet
+    else
+      puts "Stamping files...\n\n" unless quiet
+    end
+
+    stamped = 0
+    # For each file that matches pattern(s)
+    files.each do |file|
+      next unless includes.any? { |include| Regexp.new(include).match(file) }
+      next if excludes.any? { |exclude| Regexp.new(exclude).match(file) }
+
+      # Check the header of the file. Match on first lines or shifted by one line.
+      # If match, do nothing, else stamp file (or report only -- use colorize).
+      contents = IO.read(file)
+      next if contents.size < 1
+      next if contents.start_with?(stamp)
+      contents = contents.split("\n")
+      next if contents[1..-1].join("\n").start_with?(stamp)
+
+      if dryrun
+        puts file unless quiet
+        stamped += 1
+        next
+      end
+
+      if respect_first_marks.any? { |mark| Regexp.new(mark).match(contents.first) }
+        shifted = contents.shift
+        contents = shifted + "\n" + stamp + contents.join("\n")
+      else
+        contents = stamp + contents.join("\n")
+      end
+
+      IO.write(file, contents)
+      stamped += 1
+      puts file unless quiet
+    end
+
+    print "\nFinished. ".green
+    if dryrun
+      puts "#{stamped} files need stamping.".send(stamped > 0 ? :red : :green) unless quiet
+    else
+      puts "#{stamped} files were stamped.".green unless quiet
+    end
+
+    dryrun && stamped > 0 ? false : true
+  end
+end

data/lib/stamper/cli.rb

@@ -0,0 +1,109 @@
+require 'optparse'
+require 'ostruct'
+require 'logger'
+require 'stamper'
+
+module Stamper
+  def self.CLI(args) # rubocop:disable MethodName
+    options = OpenStruct.new
+
+    optparse = OptionParser.new do |opts|
+      opts.banner = 'Usage: stamper -s STAMPFILE [options]'
+      opts.separator ''
+      opts.separator "Prepends a blurb of text to any files you specify while respecting\n"\
+                     'a list of includes and exclude patterns for maximum flexibility.'
+      opts.separator ''
+
+      opts.separator 'Required:'
+      opts.on('-s', '--stamp STAMPFILE', 'Read the stamp from the specified file.') do |stamp|
+        options.stamp = stamp
+      end
+
+      opts.separator ''
+      opts.separator 'Options:'
+
+      opts.on(
+        '-p',
+        '--path DIRECTORY',
+        'Directory to scan for files. Defaults to current directory.'
+      ) do |path|
+        options.path = path
+      end
+
+      opts.on(
+        '-i',
+        '--include \'REGEXP\'',
+        "Only stamp files that match this pattern. Can be used multiple times.\n"\
+        "\t\t\t\t\tDefaults to #{Stamper::DEFAULTS[:includes]}."
+      ) do |include|
+        options.includes ||= []
+        options.includes << include
+      end
+
+      opts.on(
+        '-e',
+        '--exclude \'REGEXP\'',
+        "Do not stamp files that match this pattern. Can be used multiple times.\n"\
+        "\t\t\t\t\tEvaluated after includes. Defaults to #{Stamper::DEFAULTS[:excludes]}."
+      ) do |exclude|
+        options.excludes ||= []
+        options.excludes << exclude
+      end
+
+      opts.on(
+        '-r',
+        '--respect \'REGEXP\'',
+        "If the first line in the file matches this pattern,\n"\
+        "\t\t\t\t\tplace stamp under that line. \n"\
+        "\t\t\t\t\tCan be used multiple times. Defaults to #{Stamper::DEFAULTS[:respect_first_marks]}."
+      ) do |mark|
+        options.marks ||= []
+        options.marks << mark
+      end
+
+      opts.on(
+        '-d',
+        '--dry-run',
+        'Report which files need stamping, but don\'t make any changes.'
+      ) do |dryrun|
+        options.dryrun = dryrun
+      end
+
+      opts.on(
+        '-q',
+        '--quiet',
+        'Do not print any output.'
+      ) do |dryrun|
+        options.dryrun = dryrun
+      end
+
+      opts.on_tail('-h', '--help', 'Show this message.') do
+        puts opts
+        exit
+      end
+
+      opts.on_tail('--version', 'Show version.') do
+        puts VERSION
+        exit
+      end
+    end
+
+    optparse.parse!(args)
+
+    if options.stamp.nil?
+      puts "No stamp file specified.\n\n"
+      puts optparse
+      exit
+    end
+
+    Stamper.stamp(
+      stamp: IO.read(options.stamp),
+      files: options.path ? options.path + '/**/*' : Stamper::DEFAULTS[:files],
+      includes: options.includes ? options.includes : Stamper::DEFAULTS[:includes],
+      excludes: options.excludes ? options.excludes : Stamper::DEFAULTS[:excludes],
+      respect_first_marks: options.marks ? options.marks : Stamper::DEFAULTS[:respect_first_marks],
+      dryrun: options.dryrun,
+      quiet: options.quiet
+    )
+  end
+end

data/lib/stamper/version.rb

@@ -0,0 +1,3 @@
+module Stamper
+  VERSION = '0.1.0'
+end

data/stamper.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stamper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'stamper'
+  spec.version       = Stamper::VERSION
+  spec.authors       = ['Renier Morales']
+  spec.email         = ['renier@morales-rodriguez.net']
+  spec.summary       = %q{You know. For file stamping.}
+  spec.description   = %q{Prepends a blurb of text to any files you specify while respecting a list of includes and exclude patterns for maximum flexibility.}
+  spec.homepage      = 'https://github.com/renier/stamper'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'colorize', '~> 0.7.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.23.0'
+  spec.add_development_dependency 'pry', '~> 0.10.0'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: stamper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Renier Morales
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: Prepends a blurb of text to any files you specify while respecting a
+  list of includes and exclude patterns for maximum flexibility.
+email:
+- renier@morales-rodriguez.net
+executables:
+- stamper
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/stamper
+- lib/stamper.rb
+- lib/stamper/cli.rb
+- lib/stamper/version.rb
+- stamper.gemspec
+homepage: https://github.com/renier/stamper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: You know. For file stamping.
+test_files: []