gist_updater 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8dc664768fabfe6e4e086ab381b3b58f08274ba
-  data.tar.gz: 9b74e345d7683da1a001f56fa832c2f9a0fafd5a
+  metadata.gz: f08ce131e4b5da439fd9dbec0b196211d65bdc3d
+  data.tar.gz: c0ae0fddb076a17467d9bf7e795f6e60599a4459
 SHA512:
-  metadata.gz: 830f3f9d40f2c3b3067a18c86b59edd11ec7e9cc754213327abb2e346c26bff3ae5ad88d6ffa5ee563d49a4be6d9cbc2771811c7f035ef94ac9958479259291f
-  data.tar.gz: 23fcdd22918ccce311d79e96569d80c4a41d750b6c8de825a508318950506c1c3e831fd9295d7d1c8d8bd76439296ba4bc5ea187270c094b7f596d2b4fee7b4c
+  metadata.gz: e8dee73553e37d1549b2267c97235a23a292b21cf723aa2bb82e9323abb1a2f8a979beb5c9b38f33c41d130e78837bf1dbbc748f8f5450b4730065363c75b59e
+  data.tar.gz: dc6bddcafd3b4855787cdc6c661946c1b6414146ad2c0be0ab8c47b09a0a6935246a0dda6b6021bb7094d2d13e6e0eabf699ea01aff73a5bf86c24442fe43f4f

data/.rspec

@@ -1,2 +1,4 @@
---format documentation
 --color
+--format documentation
+--order random
+--require spec_helper

data/README.md

@@ -10,7 +10,9 @@
 
 ## Description
 
-Updates your Gist files which are defined in YAML
+Updates your Gist files defined in YAML
+
+https://masutaka.net/chalow/2016-09-29-1.html (In Japanese)
 
 ## Installation
 

data/circle.yml

@@ -5,3 +5,4 @@ dependencies:
 test:
   override:
     - bundle exec rubocop
+    - bundle exec rake spec

data/disabled.yml

@@ -23,20 +23,6 @@ Style/Copyright:
   Description: 'Include a copyright notice in each file before any code.'
   Enabled: false
 
-Style/Documentation:
-  Description: 'Document classes and non-namespace modules.'
-  Enabled: false
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-
-Style/DocumentationMethod:
-  Description: 'Public methods.'
-  Enabled: false
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-
 Style/Encoding:
   Description: 'Use UTF-8 as the source file encoding.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#utf-8'

data/enabled.yml

@@ -176,6 +176,20 @@ Style/PreferredHashMethods:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#hash-key'
   Enabled: true
 
+Style/Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+Style/DocumentationMethod:
+  Description: 'Public methods.'
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
 Style/DotPosition:
   Description: 'Checks the position of the dot in multi-line method calls.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains'

data/gist_updater.gemspec

@@ -10,8 +10,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Takashi Masuda']
   spec.email         = ['masutaka.net@gmail.com']
 
-  spec.summary       = 'Updates your Gist files'
-  spec.description   = 'Updates your Gist files which defined in YAML'
+  spec.summary       = 'Updates your Gist files defined in YAML'
+  spec.description   = <<~EOS
+    Updates your Gist files defined in YAML.
+    For example, it's useful for syncing GitHub and Gist in CI.
+  EOS
   spec.homepage      = 'https://github.com/masutaka/gist_updater'
   spec.license       = 'MIT'
 
@@ -29,4 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.43.0'
+  spec.add_development_dependency 'yard', '~> 0.9.5'
 end

data/lib/gist_updater/commands.rb

@@ -3,6 +3,7 @@
 require 'thor'
 
 module GistUpdater
+  # CLI Interface
   class Commands < Thor
     package_name 'gist_updater'
     default_task :update
@@ -17,11 +18,17 @@ module GistUpdater
                          desc: 'Debug mode', default: false
 
     desc 'update', 'Update your Gist files (default)'
+    # CLI Interface to update your Gist
+    #
+    # @return (see GistUpdater::Updater#update)
     def update
       Updater.new(options).update
     end
 
     desc 'version', 'Display version'
+    # CLI Interface to display version
+    #
+    # @return (see Kernel.puts)
     def version
       puts VERSION
     end

data/lib/gist_updater/config.rb

@@ -3,11 +3,20 @@
 require 'yaml'
 
 module GistUpdater
+  # User configuration
   class Config
+    # @param file [String] a YAML file path
     def initialize(file)
       @file = file
     end
 
+    # Calls block once for each element in config
+    #
+    # @yield [gist_id:, file_paths:] Gist file paths
+    # @yieldparam gist_id [String] a Gist id
+    # @yieldparam file_paths [Array<String>] file paths
+    # @yieldreturn [Array]
+    # @return [Enumerator]
     def each
       return enum_for(:each) unless block_given?
 

data/lib/gist_updater/content.rb

@@ -3,7 +3,12 @@
 require 'octokit'
 
 module GistUpdater
+  # A content related to a gist file
   class Content
+    # @param user [String] GitHub username
+    # @param access_token [String] GitHub personal access token
+    # @param gist_id [String] A gist id
+    # @param file_path [String] A relative file path
     def initialize(user:, access_token:, gist_id:, file_path:)
       @user         = user
       @access_token = access_token
@@ -11,6 +16,10 @@ module GistUpdater
       @file_path    = file_path
     end
 
+    # Update the content if needed
+    #
+    # @return [Sawyer::Resource] an updated resource
+    # @return [NilClass] isnot updated
     def update_if_need
       if need_to_update?
         result = update
@@ -42,6 +51,9 @@ module GistUpdater
       @local ||= File.read(file_path)
     end
 
+    # Update a Gist file
+    #
+    # @return [Sawyer::Resource]
     def update
       client.edit_gist(
         gist_id,

data/lib/gist_updater/debug.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Updates your Gist files defined in YAML
 module GistUpdater
   class << self
     attr_accessor :debug

data/lib/gist_updater/updater.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 module GistUpdater
+  # Updates according to user configuration
   class Updater
+    # @param options [Hash] options generated by Thor
+    # @param config_class [Class] a Class which has configuration duty
     def initialize(options, config_class = Config)
       @user             = options[:user] || ENV['GISTUPDATER_USER']
       @access_token     = options[:token] || ENV['GISTUPDATER_ACCESS_TOKEN']
@@ -9,6 +12,9 @@ module GistUpdater
       GistUpdater.debug = options[:debug]
     end
 
+    # Update your Gist
+    #
+    # @return [Fixnum] Updated count
     def update
       count = 0
 
@@ -25,6 +31,9 @@ module GistUpdater
 
     attr_reader :user, :access_token, :config
 
+    # Update a Gist file
+    #
+    # @return (see GistUpdater::Content#update_if_need)
     def update_by_gist(id, file_path)
       Content.new(
         user: user,

data/lib/gist_updater/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GistUpdater
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gist_updater
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Takashi Masuda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-28 00:00:00.000000000 Z
+date: 2016-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -94,7 +94,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.43.0
-description: Updates your Gist files which defined in YAML
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+description: |
+  Updates your Gist files defined in YAML.
+  For example, it's useful for syncing GitHub and Gist in CI.
 email:
 - masutaka.net@gmail.com
 executables:
@@ -149,5 +165,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Updates your Gist files
+summary: Updates your Gist files defined in YAML
 test_files: []