keg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc1cd308865efe2ea6deaf708d724c77e4d1e00e
+  data.tar.gz: de83c134e62047822433b3c23969eb46513742c5
+SHA512:
+  metadata.gz: ebe78e1d9b88851fad6a7f0b57b276af5892d9b364605cab667e8c4b58ac9a6d4ee6fa76a453ca098e7cf4c55e994ccb8a77c228e4d5a3fd4afc3b89232cc6b1
+  data.tar.gz: 2607fa3a5f15ff0257fa6cf86899871e25b05d2ff2853c86c5d7c27e651cefa14b30760c31a688b867d612c149fd039e4ea099fd479c40e6e413a40c122c47d9

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 yuta-muramoto
+
+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.ja.md

@@ -0,0 +1,93 @@
+Keg [![Circle CI](https://circleci.com/gh/bm-sms/keg.svg?style=svg&circle-token=64f349201f5cb44f1ac47b1172626522253d20ec)](https://circleci.com/gh/bm-sms/keg)
+====
+
+Kegは、データ管理支援を目的としたCLIツールです。
+
+## Description
+Kegが扱うデータは、[TOML](https://github.com/toml-lang/toml)と呼ばれる可読性の高い形式で書かれたデータです。
+Kegは、ローカルに構築されたデータベース内にあるTOML形式のファイルを読み込み、利用しやすい形式にして出力します。  
+事前に、利用したいTOMLファイルがあるリポジトリをローカルのデータベース(`$HOME/.keg/databases`)にクローンする必要があります。
+
+## VS. [glean](https://github.com/glean/glean)
+gleanは特定のリモートリポジトリからローカルにキャッシュを構築しているのに対し、Kegはローカルに構築されたデータベースを主として扱います。
+そのため、リポジトリの更新があった場合は手動でpullする必要があります。しかし、ローカルのデータを扱うため高速に動作します。
+
+## Requirements
+Ruby 2.0 以上
+
+
+## Installation
+
+Gemfileに追加する場合 :
+
+```sh
+gem 'keg'
+```
+
+手動でインストールする場合 :
+
+```sh
+$ gem install keg
+```
+
+## Usage
+### 準備:
+TOMLファイルの作成 :
+
+```toml
+# example.toml
+name = 'example'
+email = 'example@example.com'
+```
+
+作成したTOMLファイルをgitにpush :
+
+```sh
+$ git add example.toml
+$ git commit -m 'add keg example'
+$ git push origin master
+```
+
+データベースの構築 :
+
+```sh
+$ mkdir -p $HOME/.keg/databases
+$ cd $HOME/.keg/databases
+$ git clone <your_repo> example_database
+```
+
+### デモ:
+
+ローカルのパス(`$HOME/.keg/databases`)内のデータベース群からデータベースを選択する :
+
+```sh
+$ keg switch example_database   #=> switch database `example_database`
+```
+
+データベース内にある要求されたTOMLファイルをフォーマットして表示する :
+
+```sh
+$ keg show example               # show $HOME/.keg/databases/example_database/example.toml
+$ keg show --format=json example # show in json format
+$ keg show --format=yaml example # show in yaml format
+```
+
+現在選択されているデータベース名を表示する :
+
+```sh
+$ keg current                    #=> example_database
+```
+
+選択されているデータベース内の全てのTOMLファイルをフォーマットして表示する :
+
+```sh
+$ keg show_all                  # show all TOML in example_database
+$ keg show_all --format=json    # show all in json format
+$ keg show_all --format=yaml    # show all in yaml format
+```
+
+## Contributing
+バグレポートとプルリクエストは https://github.com/bm-sms/keg にてお待ちしております。コントリビューアは [Contributor Covenant](http://contributor-covenant.org) に殉ずる事をお願いします。
+
+## License
+このgemは[MIT License](http://opensource.org/licenses/MIT)の元で利用可能です。

data/README.md

@@ -0,0 +1,96 @@
+Keg [![Circle CI](https://circleci.com/gh/bm-sms/keg.svg?style=svg&circle-token=64f349201f5cb44f1ac47b1172626522253d20ec)](https://circleci.com/gh/bm-sms/keg)
+====
+
+Keg is CLI tool that supports a data management.
+
+## Description
+Keg use the data formatted by [TOML](https://github.com/toml-lang/toml) which is language that easy to read. 
+Keg read a TOML file from the local database and outputs its useful format.
+You need to clone the repository has the TOML file in the local database (`$HOME/.keg/databases`) in advance.
+
+## VS. [glean](https://github.com/glean/glean)
+glean constructs a cache in local from a specific remote repository. In contrast, Keg mainly works with the database was constructed in local. Therefore, you need to pull manually when the repository has updated. However, it run at high speed by using the data in local.
+
+## Requirements
+Ruby 2.0 higher
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```sh
+gem 'keg'
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install keg
+```
+
+## Usage
+### Preparations: 
+Makes a TOML file:
+
+```toml
+# example.toml
+name = 'example'
+email = 'example@example.com'
+```
+
+Push this TOML file to git:
+
+```sh
+$ git add example.toml
+$ git commit -m 'add example'
+$ git push origin master
+```
+
+Constructs databases:
+
+```sh
+$ mkdir -p $HOME/.keg/databases
+$ cd $HOME/.keg/databases 
+$ git clone <your_repo> example_database
+```
+
+### Demo:
+
+Select a database from databases in local (`$HOME/.keg/databases`):
+
+```sh
+$ keg switch example_database   #=> switch database `example_database`
+```
+
+Format and show the TOML file which is requested in the database:
+
+```sh
+$ keg show example               # show $HOME/.keg/databases/example_database/example.toml
+$ keg show --format=json example # show in json format
+$ keg show --format=yaml example # show in yaml format
+```
+
+Show the current database:
+
+```sh
+$ keg current                    #=> example_database
+```
+
+Format and show all TOML files in the database:
+
+```sh
+$ keg show_all                   # show all TOML file in example_database
+$ keg show_all --format=json     # show all in json format
+$ keg show_all --format=yaml     # show all in yaml format
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bm-sms/keg. 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,17 @@
+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 :test_init do
+    sh "mkdir -p $HOME/.keg/databases/glean-daimon-lunch"
+    sh "git clone git@github.com:bm-sms/glean-daimon-lunch.git $HOME/.keg/databases/glean-daimon-lunch"
+    sh "mkdir -p $HOME/.keg/databases/example"
+    sh "git clone git@github.com:yuta-muramoto/TomlTest.git $HOME/.keg/databases/example"
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "keg"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,25 @@
+machine:
+  timezone: Asia/Tokyo
+  ruby:
+    version: '2.2.3'
+  post:
+    - sudo service mysql stop
+    - sudo service postgresql stop
+
+dependencies:
+  override:
+    - rake test_init
+test:
+  override:
+    - rvm use 2.2.3
+    - gem install bundler -v 1.11.2
+    - bundle _1.11.2_ install
+    - rake test
+    - rvm use 2.1.7
+    - gem install bundler -v 1.11.2
+    - bundle _1.11.2_ install
+    - rake test
+    - rvm use 2.0.0
+    - gem install bundler -v 1.11.2
+    - bundle _1.11.2_ install
+    - rake test

data/exe/keg

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "keg"
+
+Keg::CLI.start(ARGV)

data/keg.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "keg"
+  spec.version       = Keg::VERSION
+  spec.authors       = ["yuta-muramoto"]
+  spec.email         = ["s1513114@u.tsukuba.ac.jp"]
+
+  spec.summary       = %q{This is CLI tool that supports a data management.}
+  spec.description   = <<-EOF
+  Keg use the data formatted by TOML which is language that easy to read.
+  Keg read a TOML file from the local database and outputs its useful format.
+  You need to clone the repository has the TOML file in the local database (`$HOME/.keg/databases`) in advance.
+  EOF
+  spec.homepage      = "https://github.com/bm-sms/keg"
+  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_dependency "thor"
+  spec.add_dependency "toml-rb"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-reporters"
+end

data/lib/keg.rb

@@ -0,0 +1,7 @@
+require "keg/version"
+require "keg/cli"
+require "keg/core"
+require "keg/configuration"
+require "keg/formatter"
+require "keg/formatter/json"
+require "keg/formatter/yaml"

data/lib/keg/cli.rb

@@ -0,0 +1,61 @@
+require 'keg'
+require 'thor'
+
+module Keg
+  class CLI < Thor
+    DEFAULT_FORMAT = 'json'
+    def self.exit_on_failure?; true end
+
+    def initialize(*args)
+      super
+      @database = Core.new(ENV["HOME"])
+    end
+
+    desc "switch <database>", "Database switch to <database>."
+    def switch(name)
+      begin
+        @database.switch name
+      rescue => e
+        raise Thor::InvocationError.new(e)
+      end
+      puts "Switch dataBase `#{name}`."
+    end
+
+    desc "show <file>", "output contents from <file> formatted by json or yaml."
+    method_option "format", desc: "json, yaml", default: DEFAULT_FORMAT
+    def show(filename)
+      begin
+        content = @database.select(filename)
+        formatter = Formatter.create(options[:format])
+      rescue => e
+        raise Thor::InvocationError.new(e)
+      end
+
+      puts formatter.format(content)
+    end
+
+    desc "current", "show a current database."
+    def current
+      begin
+        puts @database.current
+      rescue => e
+        raise Thor::InvocationError.new(e.message)
+      end
+    end
+
+    desc "show_all", "output all contents from current database."
+    method_option "format", desc: "json, yaml", default: DEFAULT_FORMAT
+    def show_all
+      begin
+        contents = @database.select_all
+        formatter = Formatter.create(options[:format])
+      rescue => e
+        raise Thor::InvocationError.new(e)
+      end
+
+      contents.each do |content|
+        puts formatter.format(content)
+      end
+    end
+  end
+end

data/lib/keg/configuration.rb

@@ -0,0 +1,38 @@
+require 'keg'
+
+module Keg
+  class Configuration
+    def initialize(root)
+      @root = root
+    end
+
+    def save(name)
+      config = { 'database' => name }
+      File.write(config_path, config.to_yaml)
+    end
+
+    def load
+      begin
+        @config = YAML.load_file(config_path)
+      rescue Errno::ENOENT
+        save ''
+      end
+      unless database_does_set?
+        raise 'Error: Database does not set. You should set a database.'
+      end
+
+      @config['database']
+    end
+
+    def config_path
+      File.join(@root, '.keg', 'config.yml')
+    end
+
+    def database_does_set?
+      return false unless @config
+      return false if @config['database'].nil?
+      return false if @config['database'].empty?
+      return true
+    end
+  end
+end

data/lib/keg/core.rb

@@ -0,0 +1,52 @@
+require 'keg'
+require 'toml'
+
+module Keg
+  class Core
+    def initialize(root)
+      @root = root
+      @configuration = Configuration.new(root)
+    end
+
+    def switch(name)
+      path = File.join(databases_path, name)
+      if !Dir.exists?(path) || name.empty?
+        raise "Error: No such directory `#{name}`. Please enter a exist database."
+      end
+
+      @configuration.save name
+    end
+
+    def select(filename)
+      unless Dir.exists?(current_path)
+        raise "Current database is unknown directory `#{current}`. Please set a exist database."
+      end
+
+      path = File.join(current_path, filename+'.toml')
+      TOML.load_file(path)
+    end
+
+    def current
+      @current = @configuration.load if @current.nil?
+      @current
+    end
+
+    def select_all
+      unless Dir.exists?(current_path)
+        raise "Current database is unknown directory `#{current}`. Please set a exist database."
+      end
+
+      Dir.glob("#{current_path}/**/*.toml").map do |path|
+        TOML.load_file(path)
+      end
+    end
+
+    def current_path
+      File.join(databases_path, current)
+    end
+
+    def databases_path
+      File.join(@root, '.keg', 'databases')
+    end
+  end
+end

data/lib/keg/formatter.rb

@@ -0,0 +1,14 @@
+require 'keg'
+
+module Keg
+  class Formatter
+    def self.create(format)
+      begin
+        formatter = const_get(format.capitalize)
+      rescue
+        raise "Error: Unavailable format `#{format}`. Please enter a available format `JSON` or `YAML`."
+      end
+      formatter.new
+    end
+  end
+end

data/lib/keg/formatter/json.rb

@@ -0,0 +1,12 @@
+require 'keg'
+require 'json'
+
+module Keg
+  class Formatter
+    class Json
+      def format(obj)
+        obj.to_json
+      end
+    end
+  end
+end

data/lib/keg/formatter/yaml.rb

@@ -0,0 +1,12 @@
+require 'keg'
+require 'yaml'
+
+module Keg
+  class Formatter
+    class Yaml
+      def format(obj)
+        obj.to_yaml
+      end
+    end
+  end
+end

data/lib/keg/version.rb

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

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: keg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yuta-muramoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: toml-rb
+  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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  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: minitest-reporters
+  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: |2
+    Keg use the data formatted by TOML which is language that easy to read.
+    Keg read a TOML file from the local database and outputs its useful format.
+    You need to clone the repository has the TOML file in the local database (`$HOME/.keg/databases`) in advance.
+email:
+- s1513114@u.tsukuba.ac.jp
+executables:
+- keg
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.ja.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- exe/keg
+- keg.gemspec
+- lib/keg.rb
+- lib/keg/cli.rb
+- lib/keg/configuration.rb
+- lib/keg/core.rb
+- lib/keg/formatter.rb
+- lib/keg/formatter/json.rb
+- lib/keg/formatter/yaml.rb
+- lib/keg/version.rb
+homepage: https://github.com/bm-sms/keg
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: This is CLI tool that supports a data management.
+test_files: []