deka 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac4d091e219f45f44290ef7e48a6781a9c8dc868
+  data.tar.gz: bc5e5b5a3172901bf9d554b76ee1ec31c1caa561
+SHA512:
+  metadata.gz: 03d1fe989ec67e09cfc746247fa6a723c78a840de8a7c9fb61dcb792260f0f10550f16690bae5974a5543b15e379efaf58062e0b04c1ba13d05d3b5ce0992ce9
+  data.tar.gz: 4155b9367d4445f27952eb52ac5a38dc9b861ff37b3640ce66bf3a35a23cac7d040f8d9426352aceac2651442f61012eb2b0f42a6064e550f36e378dd6f92eeb

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.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

data/.hound.yml

@@ -0,0 +1,5 @@
+StringLiterals:
+  # Valid values (denoting the preferred quote delimiters) are:
+  # single_quotes, double_quotes
+  EnforcedStyle: single_quotes
+  Enabled: true

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 willnet
+
+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,55 @@
+# Deka
+
+[![Build Status](https://travis-ci.org/willnet/deka.svg?branch=master)](https://travis-ci.org/willnet/deka)
+
+Deka provides `deka` command which track files (ex: README.md) and write github issues if new commits detected. It is useful to translate documents on github and keep them fresh.
+
+### examples of use
+
+- [willnet/capybara-readme-ja](https://github.com/willnet/capybara-readme-ja)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'deka'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deka
+
+## Usage
+
+* requirement: `git` command
+* You should create a config file (ex: `./deka.yml`) and write settings.
+* Use `deka` command to watch `watching_repo` and write issues to `issuing_repo`. If you don't want to watch all commits, write a commit hash to `.tracked_hash`, deka doesn't write issues prior to the commit hash.
+* `.tracked_hash` if automatically updated by `deka` command
+
+```
+Usage: deka [options]
+        --dry-run      Dry run
+    -c, --config       config path (default `./deka.yml`)
+    -s, --save         path for saving tracked hash (default `./.tracked_hash`)
+```
+
+### config file example
+
+```
+watching_files: 'README.md'
+watching_repo: 'willnet/readme_tracker_watching_repo'
+issuing_repo: 'willnet/readme_tracker_issuing_repo'
+body: 'please respond'
+access_token: YOUR_GITHUB_ACCESS_TOKEN
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/willnet/deka/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,7 @@
+require "bundler/gem_tasks"
+
+Bundler.setup
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+task :default => :spec

data/bin/deka

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path('../../lib', __FILE__)
+require 'bundler'
+Bundler.require
+require 'deka'
+require 'slop'
+
+opts = Slop.new(strict: true) do
+  banner 'Usage: deka [options]'
+  on 'dry-run', 'Dry run'
+  on 'c=', 'config', 'config path (default `./deka.yml`)'
+  on 's=', 'save', 'path for saving tracked hash (default `./.tracked_hash`)'
+end
+
+begin
+  opts.parse
+  Deka::Cli.run(opts.to_hash)
+rescue Slop::Error => e
+  puts e.message
+  puts opts # print help
+end

data/lib/deka.rb

@@ -0,0 +1,5 @@
+require 'deka/version'
+require 'deka/cli'
+
+module Deka
+end

data/lib/deka/cli.rb

@@ -0,0 +1,109 @@
+require 'yaml'
+require 'fileutils'
+require 'octokit'
+
+class Deka::Cli
+  attr_accessor :config, :base_hash, :yaml, :save_file
+
+  def self.run(options = {})
+    new(options).run
+  end
+
+  def initialize(options = {})
+    @config = options[:config] || './deka.yml'
+    @save_file = options[:save] || './.tracked_hash'
+    @base_hash = File.read(save_file).chomp
+    @dry_run = options[:'dry-run']
+  end
+
+  def run
+    log = fetch_log
+
+    all_hashes = log.each_line.map { |line| line.strip[0..39] }
+    issue_hashes = all_hashes.take_while { |hash| hash != base_hash }.reverse
+
+    issue_hashes.each do |issue_hash|
+      create_issue(issuing_repo, issue_hash)
+    end
+
+    update_lastest_hash(issue_hashes.last)
+  ensure
+    delete_temp_repo
+  end
+
+  def client
+    @client ||= Octokit::Client.new(access_token: access_token)
+  end
+
+  private
+
+  def yaml
+    @yaml = YAML.load(File.read(config))
+  end
+
+  def watching_files
+    yaml['watching_files'] || 'README.md'
+  end
+
+  def watching_repo
+    yaml['watching_repo']
+  end
+
+  def issuing_repo
+    yaml['issuing_repo']
+  end
+
+  def access_token
+    yaml['access_token']
+  end
+
+  def directory_name
+    watching_repo.split('/')[1]
+  end
+
+  def issue_title(issue_hash)
+    "about #{issue_hash[0..6]}"
+  end
+
+  def issue_body(issue_hash)
+    commit_url = "https://github.com/#{watching_repo}/commit/#{issue_hash}"
+    if yaml['body']
+      yaml['body'] + "\n\n#{commit_url}"
+    else
+      "please respond \n\n#{commit_url}"
+    end
+  end
+
+  def fetch_log
+    system "git clone https://github.com/#{watching_repo}.git"
+    log = ''
+    FileUtils.cd directory_name do
+      log = `git log --pretty=oneline #{watching_files}`
+    end
+    log
+  end
+
+  def create_issue(repo, hash)
+    title = issue_title(hash)
+    body = issue_body(hash)
+    unless @dry_run
+      client.create_issue(repo, title, body)
+    end
+    puts "created issue of #{hash}"
+  end
+
+  def update_lastest_hash(latest_hash)
+    unless @dry_run
+      File.open(save_file, 'w') do |file|
+        file.write(latest_hash)
+      end
+    end
+    puts "updated #{save_file} with #{latest_hash}"
+  end
+
+  def delete_temp_repo
+    if File.exist?(directory_name)
+      FileUtils.rm_r directory_name
+    end
+  end
+end

data/lib/deka/version.rb

@@ -0,0 +1,3 @@
+module Deka
+  VERSION = "0.0.1"
+end

data/readme_tracker.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deka/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'deka'
+  spec.version       = Deka::VERSION
+  spec.authors       = ['willnet']
+  spec.email         = ['netwillnet@gmail.com']
+  spec.summary       = %q{tracking commit of README}
+  spec.description   = %q{tracking commit of README}
+  spec.homepage      = 'https://github.com/willnet/deka'
+  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 'octokit'
+  spec.add_dependency 'slop'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/spec/cli_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Deka::Cli do
+  describe '#run' do
+    context 'when pass config and save_file as argument' do
+      let(:config) { File.expand_path('../support/sample.yml', __FILE__) }
+      let(:save_file) { File.expand_path('../support/.tracked_hash', __FILE__) }
+      let!(:old_hash_txt) { File.read(save_file) }
+
+      after do
+        File.open(save_file, 'w') do |file|
+          file.write(old_hash_txt)
+        end
+      end
+
+      it 'should git clone its repository and write new hash to save_file' do
+        cli = Deka::Cli.new(config: config, save: save_file)
+        expect(cli).to receive(:system).
+          with('git clone https://github.com/willnet/readme_tracker_watching_repo.git').
+          and_call_original
+        expect(cli.client).to receive(:create_issue).
+          with('willnet/readme_tracker_issuing_repo', 'about 670f679', "please respond\n\nhttps://github.com/willnet/readme_tracker_watching_repo/commit/670f67987f9616a020f91e00f146090617b06e8a")
+        expect(cli.client).to receive(:create_issue).
+          with('willnet/readme_tracker_issuing_repo', 'about ccd8832', "please respond\n\nhttps://github.com/willnet/readme_tracker_watching_repo/commit/ccd88321b9cca4ceb24fdb09c3e338656c6300fa")
+        cli.run
+        new_hash_txt = File.read(save_file)
+        expect(new_hash_txt).to eq 'ccd88321b9cca4ceb24fdb09c3e338656c6300fa'
+      end
+
+      context 'and pass dry-run is true' do
+        it 'should dry run' do
+          cli = Deka::Cli.new(
+            config: config,
+            save: save_file,
+            :'dry-run' => true
+          )
+          expect(cli).to receive(:system).
+            with('git clone https://github.com/willnet/readme_tracker_watching_repo.git').
+            and_call_original
+          expect(cli.client).not_to receive(:create_issue)
+          cli.run
+          new_hash_txt = File.read(save_file).chomp
+          expect(new_hash_txt).to eq '6ed23d83705e2cf864cc2fa7d1307e0f8131b1b9'
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,80 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'deka'
+
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/support/.tracked_hash

@@ -0,0 +1 @@
+6ed23d83705e2cf864cc2fa7d1307e0f8131b1b9

data/spec/support/sample.yml

@@ -0,0 +1,5 @@
+watching_files: 'README.md'
+watching_repo: 'willnet/readme_tracker_watching_repo'
+issuing_repo: 'willnet/readme_tracker_issuing_repo'
+body: 'please respond'
+access_token: ''

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: deka
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- willnet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: tracking commit of README
+email:
+- netwillnet@gmail.com
+executables:
+- deka
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/deka
+- lib/deka.rb
+- lib/deka/cli.rb
+- lib/deka/version.rb
+- readme_tracker.gemspec
+- spec/cli_spec.rb
+- spec/spec_helper.rb
+- spec/support/.tracked_hash
+- spec/support/sample.yml
+homepage: https://github.com/willnet/deka
+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: tracking commit of README
+test_files:
+- spec/cli_spec.rb
+- spec/spec_helper.rb
+- spec/support/.tracked_hash
+- spec/support/sample.yml