gitguard 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 926a4cd11bab7224ddd290066e613ff90f74bca0
+  data.tar.gz: c3abfebc9d0a410ea3a973441384cc7b9aba3418
+SHA512:
+  metadata.gz: 319284829202d4a4dfbad0ac2ea97156ffd835ae6381de39f978304074cae7f59f9ebd534a6230f5693ac5eacfada277ac9d79e8b85a67e24fe4413bab8d1450
+  data.tar.gz: 44ba7bc832a2418ad4f02185ec78aec4480733146f83a0cd2862db76a4cb18c7e91af389e0c7676ff712352638a0583032681451fea955fd0b9160e2d6a5605c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at akm2000@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 akm
+
+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,81 @@
+# gitguard
+
+`gitguard` supports to avoid mixing human code and generated code in a git commit.
+
+If there is/are change(s) to be commit, `gitguard` quits the command
+before you run command which generates something like this:
+
+```bash
+$ bin/rails g migtation create_books title:string
+[gitguard] There are files that need to be committed first.
+[gitguard] git status
+On branch features/gitguard
+Changes not staged for commit:
+  (use "git add <file>..." to update what will be committed)
+  (use "git checkout -- <file>..." to discard changes in working directory)
+
+	modified:   Gemfile
+	modified:   Gemfile.lock
+
+no changes added to commit (use "git add" and/or "git commit -a")
+```
+
+If there is no change to be commit, `gitguard` automatically commits
+the changes which is made by the command.
+
+`gitguard` supports not only `bin/rails generate` but `rake` tasks.
+You can configure rake task names in `.gitguard` file.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gitguard', group: :development
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gitguard
+
+## Setup
+
+```bash
+$ bin/rails generate gitguard:install
+```
+
+A file `.gitguard` will be generated. You can configure the behavior by editing the file.
+
+## Usage
+
+Nothing special to do after setup. You can use `rails generate` and `rake` like before.
+
+### Disabling
+
+If you don't want to commit the changes, you can disable gitguard by environment variable `GITGUARD` like this:
+
+```bash
+$ bin/rails db:migrate GITGUARD=off
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/akm/gitguard. 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](http://opensource.org/licenses/MIT).
+

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 "gitguard"
+
+# 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

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/gitguard-rails

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "gitguard"

data/gitguard.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gitguard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gitguard"
+  spec.version       = Gitguard::VERSION
+  spec.authors       = ["akm"]
+  spec.email         = ["akm2000@gmail.com"]
+
+  spec.summary       = %q{Keep commit clear by checking workspace before generate something}
+  spec.description   = %q{Keep commit clear by checking workspace before generate something}
+  spec.homepage      = "https://github.com/akm/gitguard"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/generators/gitguard/install_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/base'
+
+module Gitguard
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc "Generate config file for gitguard"
+
+    def generate_config
+      template 'config.yml', '.gitguard'
+    end
+  end
+end

data/lib/generators/gitguard/templates/config.yml

@@ -0,0 +1,4 @@
+tasks:
+- dump
+- generate
+- migrate

data/lib/gitguard/config.rb

@@ -0,0 +1,36 @@
+require 'gitguard'
+
+require 'yaml'
+
+module Gitguard
+  module Config
+    extend self
+
+    CONFIG_FILENAME = '.gitguard'.freeze
+
+    def config
+      @config ||= load_config
+    end
+
+    def load_config
+      YAML.load_file(config_path)
+    end
+
+    def config_path
+      unless @config_path
+        dir = DirSearch.up{|dir| File.readable?(File.join(dir, CONFIG_FILENAME)) }
+        raise Error, "File not found: #{CONFIG_FILENAME}" unless dir
+        @config_path = File.join(dir, CONFIG_FILENAME)
+      end
+      @config_path
+    end
+
+    def rake_task_patterns
+      config['tasks'].map{|t| Regexp.new(t) }
+    end
+
+    def target_rake_task?(task)
+      rake_task_patterns.any?{|ptn| ptn =~ task}
+    end
+  end
+end

data/lib/gitguard/dir_search.rb

@@ -0,0 +1,20 @@
+require 'gitguard'
+
+module Gitguard
+  module DirSearch
+    module_function
+
+    class DirNotFound < StandardError
+    end
+    
+    def up(dir = Dir.pwd, &block)
+      return dir if yield(dir)
+      parent = File.dirname(dir)
+      if dir == parent
+        return nil
+      else
+        return up(parent, &block)
+      end
+    end
+  end
+end

data/lib/gitguard/rails/commands_tasks.rb

@@ -0,0 +1,23 @@
+module Gitguard
+  module Rails
+    module CommandsTasks
+
+      TARGET_COMMANDS = %(plugin generate destroy).freeze
+
+      def require_command!(command)
+        if target?(command.to_s)
+          Gitguard.run("bin/rails #{command} #{argv.join(' ')}"){ super }
+        else
+          super
+        end
+      end
+
+      def target?(command)
+        return false if argv.empty?
+        Gitguard.enabled? && TARGET_COMMANDS.include?(command) &&
+          (command == 'generate' ? !argv.include?('gitguard:install') : true)
+      end
+
+    end
+  end
+end

data/lib/gitguard/rails.rb

@@ -0,0 +1,7 @@
+require "gitguard"
+
+module Gitguard
+  module Rails
+    autoload :CommandsTasks, 'gitguard/rails/commands_tasks'
+  end
+end

data/lib/gitguard/railtie.rb

@@ -0,0 +1,16 @@
+require 'gitguard'
+
+require 'rails'
+require 'rails/commands/commands_tasks'
+
+module Gitguard
+  class Railtie < ::Rails::Railtie
+    generators do
+      ::Rails::CommandsTasks.__send__(:prepend, ::Gitguard::Rails::CommandsTasks)
+    end
+
+    rake_tasks do
+      ::Rake::Application.__send__(:prepend, ::Gitguard::RakeApplication)
+    end
+  end
+end

data/lib/gitguard/rake_application.rb

@@ -0,0 +1,15 @@
+require 'gitguard'
+
+require 'rake/application'
+
+module Gitguard
+  module RakeApplication
+    def top_level
+      if Gitguard.enabled? && top_level_tasks.any?{|arg| Gitguard.target_rake_task?(arg)}
+        Gitguard.run("bin/rake #{top_level_tasks.join(' ')}"){ super }
+      else
+        super
+      end
+    end
+  end
+end

data/lib/gitguard/runner.rb

@@ -0,0 +1,42 @@
+require 'gitguard'
+require 'shellwords'
+
+require 'yaml'
+
+module Gitguard
+  class Runner
+    attr_reader :user_command
+    def initialize(user_command)
+      @user_command = user_command
+    end
+
+    def execute(&block)
+      unless clean?
+        $stderr.puts "\e[31m[gitguard] There are files that need to be committed first.\e[0m"
+        $stderr.puts "[gitguard] git status"
+        system 'git status'
+        exit(1)
+      end
+      yield
+      return if clean?
+      root_dir = DirSearch.up{|dir| Dir.exist?(File.join(dir, '.git')) }
+      raise Error, "Directory not found: .git" unless root_dir
+      Dir.chdir(root_dir) do
+        cmd = "git add . && git commit -m #{Shellwords.escape(user_command)}"
+        puts "\e[34m#{cmd}"
+        r = false
+        begin
+          r = system(cmd)
+        ensure
+          print "\e[0m"
+        end
+        raise Error, "Error on #{cmd}" unless r
+      end
+    end
+
+    def clean?
+      system("git diff --exit-code > /dev/null")
+    end
+
+  end
+end

data/lib/gitguard/version.rb

@@ -0,0 +1,3 @@
+module Gitguard
+  VERSION = "0.1.0"
+end

data/lib/gitguard.rb

@@ -0,0 +1,31 @@
+require "gitguard/version"
+require 'gitguard/railtie'
+
+module Gitguard
+  autoload :Config   , 'gitguard/config'
+  autoload :DirSearch, 'gitguard/dir_search'
+  autoload :Rails    , 'gitguard/rails'
+  autoload :RakeApplication, 'gitguard/rake_application'
+  autoload :Runner   , 'gitguard/runner'
+
+  class Error < StandardError
+  end
+  
+  class << self
+    def run(user_command, &block)
+      Runner.new(user_command).execute(&block)
+    end
+
+    def target_rake_task?(task)
+      Config.target_rake_task?(task)
+    end
+
+    def enabled?
+      !disabled?
+    end
+
+    def disabled?
+      ENV['GITGUARD'] =~ /false|no|off|0/i
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: gitguard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- akm
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Keep commit clear by checking workspace before generate something
+email:
+- akm2000@gmail.com
+executables:
+- gitguard-rails
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gitguard-rails
+- gitguard.gemspec
+- lib/generators/gitguard/install_generator.rb
+- lib/generators/gitguard/templates/config.yml
+- lib/gitguard.rb
+- lib/gitguard/config.rb
+- lib/gitguard/dir_search.rb
+- lib/gitguard/rails.rb
+- lib/gitguard/rails/commands_tasks.rb
+- lib/gitguard/railtie.rb
+- lib/gitguard/rake_application.rb
+- lib/gitguard/runner.rb
+- lib/gitguard/version.rb
+homepage: https://github.com/akm/gitguard
+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.6.4
+signing_key: 
+specification_version: 4
+summary: Keep commit clear by checking workspace before generate something
+test_files: []