rusky 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df3aa342ba13d0944def81bba2cc1cba8d3e77ab
-  data.tar.gz: ea7f33e03538cfc6ec192c784d376c518495bf17
+  metadata.gz: f3486401faaa9256285e4bb78ac2e568b02b44fb
+  data.tar.gz: 4331ad56642deef3eb5c780475fadc2938f81940
 SHA512:
-  metadata.gz: d04613960f789fa70be3a76154bcdd57f6d96cbfa3c6b644da9f6251dd23f54068a0c0d5bcdb65aa6e340128addb21b504c40e2ba4a397fca66c19c31ca8ddf3
-  data.tar.gz: 547e587628bfe538730ea08b14a2f3038acfdfb4e52d02a25a6d92ddbd28c5d7a35071483da9312628f83279948562bd38004a3f2acb627ecf971fb1edd88301
+  metadata.gz: 5df28b56ad76d8614455ba01072e9f440826ee5ddf663740cd76298b034318eb5c591ff8acd11c39e6941720431007003c2491338eb02118dc431e26f6cda026
+  data.tar.gz: b951a4b78910fdb7fcef0b173a2285abd7b72e97eca18287fe7c5baf0758c69af7d6ad317bc8c821ae363310bc460ca7e6df6014394045f3c25f5c6a4b15b34c

data/.travis.yml

@@ -3,3 +3,5 @@ language: ruby
 rvm:
   - 2.4.1
 before_install: gem install bundler -v 1.15.4
+script:
+  - bundle exec rspec

data/README.md

@@ -1,43 +1,70 @@
 # Rusky
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rusky`. To experiment with that code, run `bin/console` for an interactive prompt.
+Rusky helps you to manage Git hooks easily.
 
-TODO: Delete this and the text above, and describe your gem
+If you don't know Git hooks well, [the official document](https://git-scm.com/docs/githooks) would help you.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rusky'
+gem 'rusky', group: :development
 ```
 
 And then execute:
 
-    $ bundle
+```console
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install rusky
+```console
+$ gem install rusky
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+1. Add the following line into your Rakefile. It defines rake tasks to be executed on Git hook. The task names are 'rusky:#{git_hook_name}'.
+
+```ruby
+require "rusky/task"
+```
+
+2. Create `.rusky` file and define what you want on Git hooks as YAML. Keys should be Git hook name. Values should be an array of shell commands. Rusky executes those commands on Git hook.
+
+```yaml
+# .rusky
+pre-commit:
+  - rubocop
+pre-push:
+  - bundle exec rspec
+```
+
+### Customizable callback rake task
+
+You can write your own rake task as a callback of Git hook.
+
+```ruby
+# Rakefile
+namespace :rusky do
+  task :pre_commit do
+    # Your awesome task
+  end
+end
+````
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` 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/[USERNAME]/rusky. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ohbarye/rusky. 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).
-
-## Code of Conduct
-
-Everyone interacting in the Rusky project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rusky/blob/master/CODE_OF_CONDUCT.md).

data/lib/rusky.rb

@@ -1,12 +1,103 @@
-require "rusky/version"
-require "rusky/callback"
+require 'rusky/version'
+require 'yaml'
+require 'fileutils'
 
 module Rusky
+  HOOKS = %w[
+    applypatch-msg
+    pre-applypatch
+    post-applypatch
+    pre-commit
+    prepare-commit-msg
+    commit-msg
+    post-commit
+    pre-rebase
+    post-checkout
+    post-merge
+    pre-push
+    pre-receive
+    update
+    post-receive
+    post-update
+    push-to-checkout
+    pre-auto-gc
+    post-rewrite
+    sendemail-validate
+  ].freeze
+
   def self.install
-    Rusky::Callback.install
+    cwd = `lsof -p #{Process.ppid} | grep cwd`.split(" ").last
+
+    git_path = File.join(cwd, '.git')
+    if !File.exists? git_path
+      puts "can't find .git directory, skipping Git hooks installation"
+      return
+    end
+
+    hook_path = File.join(git_path, 'hooks')
+    if !File.exists? hook_path
+      FileUtils.mkdir_p hook_path
+    end
+
+    HOOKS.map do |hook_name|
+      create_hook(hook_name, hook_path, cwd)
+    end
+
+    # TODO create Rusky file
+    # TODO add `require` into Rakefile?
+  rescue => e
+    puts "unexpected error happened: #{e.inspect}"
+  end
+
+  def self.create_hook(hook_name, hook_path, cwd)
+    script = get_hook_script(hook_name, cwd)
+    filename = File.join(hook_path, hook_name)
+
+    # TODO check if it's okay to overwrite
+
+    write(filename, script)
   end
 
+  def self.write(filename, script)
+    File.write filename, script
+    FileUtils.chmod(0755, filename)
+  end
+
+  def self.get_hook_script(hook_name, cwd)
+    no_verify_message = if hook_name == 'prepare-commit-msg'
+                          '(cannot be bypassed with --no-verify due to Git specs)'
+                        else
+                          '(add --no-verify to bypass)'
+                        end
+
+    rake_task_name = "rusky:#{hook_name.gsub('-', '_')}"
+
+    <<~EOS
+      #!/bin/sh
+      #rusky #{Rusky::VERSION}
+      has_hook_script () {
+        [ -f .rusky ] && cat .rusky | grep -q "$1:"
+      }
+      cd "#{cwd}"
+      # Check if #{hook_name} script is defined, skip if not
+      has_hook_script #{hook_name} || exit 0
+
+      # Export Git hook params
+      export GIT_PARAMS="$*"
+      # Run command
+      echo "rusky > #{hook_name} Git hook is running"
+      echo "rusky > bundle exec rake #{rake_task_name}"
+      echo
+      bundle exec rake #{rake_task_name} || {
+        echo
+        echo "rusky > #{hook_name} Git hook failed #{no_verify_message}"
+        exit 1
+      }
+    EOS
+  end
+
+
   def self.uninstall
-    Rusky::Callback.uninstall
+    # TODO uninstall
   end
 end

data/lib/rusky/task.rb

@@ -0,0 +1,42 @@
+require 'rake'
+require 'yaml'
+require 'rusky'
+
+module Rusky
+  class Task
+    include Rake::DSL if defined? Rake::DSL
+
+    class << self
+      def install_tasks(base=nil)
+        new(base).install
+      end
+    end
+
+    def initialize(base=nil)
+      @base = base || `lsof -p #{Process.ppid} | grep cwd`.split(" ").last
+      @yaml = YAML.load_file(File.join(@base, '.rusky'))
+    end
+
+    def install
+      Rusky::HOOKS.each do |hook_name|
+        rake_task_name = "rusky:#{hook_name.gsub('-', '_')}"
+
+        # prioritize existing user hook
+        if Rake::Task.task_defined? rake_task_name
+          next # Need to invoke?
+        end
+
+        task "#{rake_task_name}" do
+          commands = @yaml[hook_name]
+
+          commands.each do |command|
+            puts "rusky > #{command}"
+            system(command) || raise("#{command} failed")
+          end
+        end
+      end
+    end
+  end
+end
+
+Rusky::Task.install_tasks

data/lib/rusky/version.rb

@@ -1,3 +1,3 @@
 module Rusky
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/rusky.gemspec

@@ -5,28 +5,22 @@ require "rusky/version"
 
 Gem.post_install do |installer|
   require "rusky"
-
   Rusky.install
-  puts installer.inspect
-  puts installer.instance_variable_get(:gem_dir)
 end
 
 Gem.pre_uninstall do |uninstaller|
   require "rusky"
-
   Rusky.uninstall
-  puts uninstaller.inspect
-  puts installer.instance_variable_get(:gem_dir)
 end
 
 Gem::Specification.new do |spec|
   spec.name          = "rusky"
   spec.version       = Rusky::VERSION
-  spec.authors       = ["ohbarye"]
+  spec.authors       = ["Masato Ohba"]
   spec.email         = ["over.rye@gmail.com"]
 
-  spec.summary       = "Add githooks easily"
-  spec.description   = "Prevents bad commit or push (git hooks, pre-commit/precommit, pre-push/prepush, post-merge/postmerge and all that stuff...)"
+  spec.summary       = "Add Git hooks easily"
+  spec.description   = "Rusky helps you to manage Git hooks easily."
   spec.homepage      = "https://github.com/ohbarye/rusky"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rusky
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
-- ohbarye
+- Masato Ohba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-30 00:00:00.000000000 Z
+date: 2017-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,8 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Prevents bad commit or push (git hooks, pre-commit/precommit, pre-push/prepush,
-  post-merge/postmerge and all that stuff...)
+description: Rusky helps you to manage Git hooks easily.
 email:
 - over.rye@gmail.com
 executables: []
@@ -63,7 +62,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
-- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -71,7 +69,7 @@ files:
 - bin/console
 - bin/setup
 - lib/rusky.rb
-- lib/rusky/callback.rb
+- lib/rusky/task.rb
 - lib/rusky/version.rb
 - rusky.gemspec
 homepage: https://github.com/ohbarye/rusky
@@ -97,5 +95,5 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: Add githooks easily
+summary: Add Git hooks easily
 test_files: []

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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 over.rye@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/lib/rusky/callback.rb

@@ -1,15 +0,0 @@
-module Rusky
-  module Callback
-    def self.install
-      puts 'installed'
-      rusky_dir = File.expand_path(File.dirname($0))
-      puts rusky_dir
-    end
-
-    def self.uninstall
-      puts 'uninstalled'
-      rusky_dir = File.expand_path(File.dirname($0))
-      puts rusky_dir
-    end
-  end
-end