zug_zug 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd14f64e44515d5823dfdd0814ba7f4a97c5712646e13b754fb5d096212e5e84
+  data.tar.gz: 64a64142ede0ce60c643550aa32820c4175b271c1e53175124482db1e92872ed
+SHA512:
+  metadata.gz: edd31dee0cb4fc59afd5aa9d76b87a52143ee09213be8807d2efeecff67ec4f4c07e1402fb268c820186bbef7760691185fdd4c40d8fbab604e682f568fcd929
+  data.tar.gz: b98edcb08a65ecff5007651c98af447d0d9347d57b64b91ccfa8c27f3739452083e622343eefb20e4cf7d5b0258cc750b118c5f304af84a1c9325c6b666d53c1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.1.0
+
+### Added
+
+*   A basic soundboard that can play two sounds (`:zug_zug` and `:work_complete`), from two 
+    different sets (one for the Horde, one for the Alliance).
+*   A basic dispatcher (`QuarterMaster`) that uses the soundboard when triggered.
+*   A CLI that generates git hook scripts ; these scripts make use of the dispatcher.
+

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    zug_zug (0.1.0)
+      thor (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.3)
+    minitest (5.12.2)
+    minitest-reporters (1.3.8)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (13.0.0)
+    ruby-progressbar (1.10.1)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.3)
+  rake (~> 13.0)
+  zug_zug!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ronan Limon Duparcmeur
+
+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,40 @@
+# ZugZug
+
+[![Build Status](https://travis-ci.org/r3trofitted/zug_zug.svg?branch=master)](https://travis-ci.org/r3trofitted/zug_zug)
+
+Hook Warcraft sounds to your Git commands
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zug_zug'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zug_zug
+
+## Usage
+
+    cd /your/repo
+    zug_zug join <alliance|horde>
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/r3trofitted/zug_zug.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zug_zug"
+
+# 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(__FILE__)

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/zug_zug

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "zug_zug/cli"
+ZugZug::CLI.start

data/lib/zug_zug.rb

@@ -0,0 +1,8 @@
+require "zug_zug/version"
+
+module ZugZug
+  HORDE    = :horde
+  ALLIANCE = :alliance
+  
+  Error = Class.new(StandardError)
+end

data/lib/zug_zug/cli.rb

@@ -0,0 +1,19 @@
+require "thor"
+
+module ZugZug
+  class CLI < Thor
+    include Thor::Actions
+    
+    desc "join FACTION", "install the FACTION git hooks"
+    def join(faction)
+      FileUtils.chmod 0751, template("post_checkout", ".git/hooks/post-checkout", faction: faction)
+      FileUtils.chmod 0751, template("post_merge", ".git/hooks/post-merge", faction: faction)
+      
+      puts "You are now part of the #{faction}!"
+    end
+    
+    def self.source_root
+      File.join __dir__, "templates"
+    end
+  end
+end

data/lib/zug_zug/quarter_master.rb

@@ -0,0 +1,21 @@
+require "zug_zug/soundboard"
+
+module ZugZug
+  class QuarterMaster
+    def initialize(faction = HORDE)
+      @soundboard = Soundboard.new(faction)
+    end
+
+    def checked_out!(argv)
+      previous_head, new_head, branch_flag = argv
+      
+      if branch_flag == "1" && new_head == previous_head
+        @soundboard.work_starts
+      end
+    end
+    
+    def merged!(argv)
+      @soundboard.work_is_over
+    end
+  end
+end

data/lib/zug_zug/soundboard.rb

@@ -0,0 +1,58 @@
+require "zug_zug"
+
+module ZugZug
+  class Soundboard
+    HORDE_SOUNDS = {
+      zug_zug: "zug_zug.wav",
+      work_complete: "work_complete.wav"
+    }
+    
+    ALLIANCE_SOUNDS = {
+      zug_zug: "alright.wav",
+      work_complete: "jobs_done.wav"
+    }
+    
+    def self.board_for(faction)
+      case faction
+      when HORDE
+        HORDE_SOUNDS
+      when ALLIANCE
+        ALLIANCE_SOUNDS
+      else
+        fail ArgumentError, "#{faction} is not a valid faction (valid factions are #{HORDE} and #{ALLIANCE})"
+      end
+    end
+    
+    def initialize(faction, plugin: default_plugin)
+      @_board  = Soundboard.board_for faction
+      @_plugin = plugin
+    end
+  
+    def work_starts
+      play sound_file(:zug_zug)
+    end
+  
+    def work_is_over
+      play sound_file(:work_complete)
+    end
+  
+    def play(file)
+      @_plugin.call(file)
+    end
+    
+    def sound_file(sound)
+      file_name = @_board.fetch sound
+      File.join __dir__, "sounds", file_name
+    end
+    
+    private
+    
+    def default_plugin
+      if RUBY_PLATFORM.include? "x86_64-darwin"
+        ->(file) { system "afplay", file }
+      else
+        ->(file) { true }
+      end
+    end
+  end
+end

data/lib/zug_zug/templates/post_checkout.tt

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "zug_zug/quarter_master"
+
+ZugZug::QuarterMaster.new(:<%= config[:faction] %>).checked_out! ARGV

data/lib/zug_zug/templates/post_merge.tt

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "zug_zug/quarter_master"
+
+ZugZug::QuarterMaster.new(:<%= config[:faction] %>).merged! ARGV

data/lib/zug_zug/version.rb

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

data/zug_zug.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "zug_zug/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "zug_zug"
+  spec.version       = ZugZug::VERSION
+  spec.authors       = ["Ronan Limon Duparcmeur"]
+  spec.email         = ["ronan@2-45.pm"]
+
+  spec.summary       = "Hook Warcraft sounds to your Git commands"
+  spec.homepage      = "https://github.com/r3trofitted/zug_zug"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/r3trofitted/zug_zug"
+  spec.metadata["changelog_uri"]   = "https://github.com/r3trofitted/zug_zug/CHANGELOG.md"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor", "~> 0.20"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.3"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: zug_zug
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ronan Limon Duparcmeur
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 
+email:
+- ronan@2-45.pm
+executables:
+- zug_zug
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/zug_zug
+- lib/zug_zug.rb
+- lib/zug_zug/cli.rb
+- lib/zug_zug/quarter_master.rb
+- lib/zug_zug/soundboard.rb
+- lib/zug_zug/sounds/alright.wav
+- lib/zug_zug/sounds/jobs_done.wav
+- lib/zug_zug/sounds/work_complete.wav
+- lib/zug_zug/sounds/zug_zug.wav
+- lib/zug_zug/templates/post_checkout.tt
+- lib/zug_zug/templates/post_merge.tt
+- lib/zug_zug/version.rb
+- zug_zug.gemspec
+homepage: https://github.com/r3trofitted/zug_zug
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/r3trofitted/zug_zug
+  source_code_uri: https://github.com/r3trofitted/zug_zug
+  changelog_uri: https://github.com/r3trofitted/zug_zug/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Hook Warcraft sounds to your Git commands
+test_files: []