rusky 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3486401faaa9256285e4bb78ac2e568b02b44fb
-  data.tar.gz: 4331ad56642deef3eb5c780475fadc2938f81940
+  metadata.gz: b70c085e2caab3d7284902bfd34eecb999001b5d
+  data.tar.gz: 07ce62ef2eb50ce35162758dba22c449e4909e92
 SHA512:
-  metadata.gz: 5df28b56ad76d8614455ba01072e9f440826ee5ddf663740cd76298b034318eb5c591ff8acd11c39e6941720431007003c2491338eb02118dc431e26f6cda026
-  data.tar.gz: b951a4b78910fdb7fcef0b173a2285abd7b72e97eca18287fe7c5baf0758c69af7d6ad317bc8c821ae363310bc460ca7e6df6014394045f3c25f5c6a4b15b34c
+  metadata.gz: 2d0ceeef2bb8b9f4efc214bca2f93c992ce874d084a17e27337512fc30bad0b81bc30d69080f1725665391c84dc2695e403327b8f0afa0a0b7445653a42bc6e3
+  data.tar.gz: 95777dfb0ae9f2422354545dea9820f715cc96377d1a838c1dc55d4adcf0d0d819f3c91ac7623749311792137cd17f973a0326167ead1bec3738c58c0e1c5ef2

data/.gitignore

@@ -10,3 +10,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+# Use .rusky file for test only
+.rusky

data/README.md

@@ -1,6 +1,8 @@
 # Rusky
 
-Rusky helps you to manage Git hooks easily.
+Rusky is a lightweight library which helps you to manage Git hooks easily. Once you set up Rusky, it would be beneficial for all your team.
+
+This library is inspired an awesome npm library, [husky](https://github.com/typicode/husky). So Rusky = Ruby + husky.
 
 If you don't know Git hooks well, [the official document](https://git-scm.com/docs/githooks) would help you.
 
@@ -24,12 +26,15 @@ Or install it yourself as:
 $ gem install rusky
 ```
 
+After installation, Rusky automatically creates git hook scripts in `.git/hooks` directory. It does not remove existing files.
+
 ## Usage
 
-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}'.
+1. Add the following lines 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"
+Rusky::Task.install
 ```
 
 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.
@@ -48,12 +53,18 @@ You can write your own rake task as a callback of Git hook.
 
 ```ruby
 # Rakefile
+require "rusky/task"
+
 namespace :rusky do
   task :pre_commit do
     # Your awesome task
   end
 end
-````
+
+Rusky::Task.install
+```
+
+NOTE: You have to call `Rusky::Task.install` after your task definition. Otherwise, the task is defined twice. According to the current Rake spec, such a duplicated task does not overwrite a former one, both run when calling the task.  
 
 ## Development
 

data/lib/rusky/task.rb

@@ -7,14 +7,15 @@ module Rusky
     include Rake::DSL if defined? Rake::DSL
 
     class << self
-      def install_tasks(base=nil)
+      def install(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'))
+      rusky_setting_file_path = File.join(@base, '.rusky')
+      @yaml = File.exists?(rusky_setting_file_path) ? YAML.load_file(File.join(@base, '.rusky')) : Hash.new([])
     end
 
     def install
@@ -22,21 +23,27 @@ module Rusky
         rake_task_name = "rusky:#{hook_name.gsub('-', '_')}"
 
         # prioritize existing user hook
-        if Rake::Task.task_defined? rake_task_name
-          next # Need to invoke?
-        end
+        next if Rake::Task.task_defined? rake_task_name
+
+        define_task hook_name, rake_task_name
+      end
+    end
+
+    def define_task(hook_name, rake_task_name)
+      task "#{rake_task_name}" do
+        commands = @yaml[hook_name]
 
-        task "#{rake_task_name}" do
-          commands = @yaml[hook_name]
+        if commands.empty?
+          puts "rusky > No command for #{hook_name} is defined in .rusky file"
+          next
+        end
 
-          commands.each do |command|
-            puts "rusky > #{command}"
-            system(command) || raise("#{command} failed")
-          end
+        commands.each do |command|
+          puts "rusky > #{command}"
+          system(command) || raise("rusky > #{command} failed")
         end
       end
     end
   end
 end
 
-Rusky::Task.install_tasks

data/lib/rusky/version.rb

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

data/lib/rusky.rb

@@ -39,12 +39,14 @@ module Rusky
       FileUtils.mkdir_p hook_path
     end
 
-    HOOKS.map do |hook_name|
+    HOOKS.each do |hook_name|
       create_hook(hook_name, hook_path, cwd)
     end
 
-    # TODO create Rusky file
-    # TODO add `require` into Rakefile?
+    rusky_setting_file_path = File.join(cwd, '.rusky')
+    if !File.exists? rusky_setting_file_path
+      File.write(rusky_setting_file_path, '')
+    end
   rescue => e
     puts "unexpected error happened: #{e.inspect}"
   end
@@ -53,9 +55,16 @@ module Rusky
     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)
+    if File.exists? filename
+      if File.read(filename).include? 'rusky'
+        # Overwrite
+        write(filename, script)
+      else
+        # Keep user original Git hook
+      end
+    else
+      write(filename, script)
+    end
   end
 
   def self.write(filename, script)
@@ -98,6 +107,27 @@ module Rusky
 
 
   def self.uninstall
-    # TODO uninstall
+    cwd = `lsof -p #{Process.ppid} | grep cwd`.split(" ").last
+
+    HOOKS.each do |hook_name|
+      remove_hook(cwd, hook_name)
+    end
+
+    rusky_setting_file_path = File.join(cwd, '.rusky')
+    if File.exists? rusky_setting_file_path
+      File.delete(rusky_setting_file_path)
+      puts "rusky > removing .rusky file..."
+    end
+
+    puts "rusky > uninstall is done. please remove rake tasks for rusky if you have them"
+    puts "rusky > Thank you for using rusky!"
+  end
+
+  def self.remove_hook(cwd, hook_name)
+    filename = File.join(cwd, '.git', 'hooks', hook_name)
+    if File.exists?(filename) && File.read(filename).include?('rusky')
+      puts "rusky > removing #{hook_name} hook script..."
+      File.delete(filename)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rusky
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Masato Ohba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-02 00:00:00.000000000 Z
+date: 2017-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler