gist_updater 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5eebf362cbfac0fde77291183280648a756e2ce0
-  data.tar.gz: ace6e7aa424f322d0eea4c02d28767ebd9975ebd
+  metadata.gz: 859a672a39a6718364468dcfc00bc952ca1b66e8
+  data.tar.gz: 964adf30b91cb82e39b2477a4835df45a38a86b4
 SHA512:
-  metadata.gz: 12e5950a74565d6c28362b26f602b6466616df71e965f002fc753cd3088ce5f4dd452e7d8374ba26e773437d9595661cbc0ab25df3341bbd81ba2a8baf578093
-  data.tar.gz: 4eb1d19014098ffe00c1449fd3b78253b255fc69ef735ff57e2f880a051a537cdc54874b08702ae5facb4dc82d9d5cd3986f997c3a6915d5d4b34f29767b2bcf
+  metadata.gz: 80a86501c6e476f35082c3e8f287be1769d80875326755c9d28b10e156776ad8be785ef4fdc9815a65c3b0b4f355d4e7d783e74ce0e2109609902dbd17dbe8e4
+  data.tar.gz: a117929285e50fddc3ac71bbf6f7b94c160bc39b567746736999e515a12c2ecf4b310f30a3b6668d82e5e0c6f4122c1e75075cf8f3a99c8f8886210e80a8a19f

data/README.md

@@ -1,5 +1,15 @@
 # GistUpdater
 
+[![Build Status](https://img.shields.io/circleci/project/masutaka/gist_updater/master.svg?maxAge=2592000?style=flat-square)][circleci]
+[![License](https://img.shields.io/github/license/masutaka/gist_updater.svg?maxAge=2592000?style=flat-square)][license]
+[![Gem](https://img.shields.io/gem/v/gist_updater.svg?maxAge=2592000?style=flat-square)][gem-link]
+
+[circleci]: https://circleci.com/gh/masutaka/gist_updater
+[license]: https://github.com/masutaka/gist_updater/blob/master/LICENSE.txt
+[gem-link]: http://badge.fury.io/rb/gist_updater
+
+## Description
+
 Updates your Gist files which are defined in YAML
 
 ## Installation
@@ -20,6 +30,8 @@ Or install it yourself as:
 
 ## Usage
 
+### CLI
+
 ```
 gist_updater commands:
   gist_updater help [COMMAND]  # Describe available commands or one specific command
@@ -34,7 +46,21 @@ Options:
   d, [--debug], [--no-debug]  # Debug mode
 ```
 
-### YAML format
+### Script
+
+```ruby
+require 'gist_updater'
+
+GistUpdater::Updater.new(
+  yaml:   <User definition YAML file>,
+  user:   <GitHub usename>,               # or $GISTUPDATER_USER
+  token:  <GitHub personal access token>, # or $GISTUPDATER_ACCESS_TOKEN
+  debug:  <true or false>
+).update
+#=> update count
+```
+
+## YAML format
 
 ```yaml
 -
@@ -66,7 +92,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gist_updater. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/masutaka/gist_updater. 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

data/lib/gist_updater/commands.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'thor'
-require 'yaml'
 
 module GistUpdater
   class Commands < Thor
@@ -19,45 +18,12 @@ module GistUpdater
 
     desc 'update', 'Update your Gist files (default)'
     def update
-      configs.each do |config|
-        content = ContentFactory.build(user, access_token, config)
-
-        if content.gist == content.local
-          puts <<~EOS if options[:debug]
-            There was no need to update `#{content.name}`.
-          EOS
-        else
-          content.update
-        end
-      end
+      Updater.new(options).update
     end
 
     desc 'version', 'Display version'
     def version
       puts VERSION
     end
-
-    private
-
-    def configs
-      @configs ||= YAML.load(IO.read(options[:yaml]))
-    end
-
-    def user
-      @user ||= options[:user] ||
-                ENV['GISTUPDATER_USER'] ||
-                help_and_exit
-    end
-
-    def access_token
-      @access_token ||= options[:token] ||
-                        ENV['GISTUPDATER_ACCESS_TOKEN'] ||
-                        help_and_exit
-    end
-
-    def help_and_exit
-      help
-      exit(1)
-    end
   end
 end

data/lib/gist_updater/config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module GistUpdater
+  class Config
+    def initialize(file)
+      @file = file
+    end
+
+    def each
+      return enum_for(:each) unless block_given?
+
+      config.each do |gist_id, file_path|
+        yield(gist_id, file_path)
+      end
+    end
+
+    private
+
+    attr_reader :file
+
+    def config
+      @config ||= YAML.load(IO.read(file))
+    end
+  end
+end

data/lib/gist_updater/content.rb

@@ -4,37 +4,53 @@ require 'octokit'
 
 module GistUpdater
   class Content
-    attr_reader :name
+    def initialize(user:, access_token:, gist_id:, file_path:)
+      @user         = user
+      @access_token = access_token
+      @gist_id      = gist_id
+      @file_path    = file_path
+    end
 
-    def initialize(user:, access_token:, gist_id:, file_name:)
-      @client = Octokit::Client.new(
-        login:        user,
-        access_token: access_token
-      )
-      @gist_id  = gist_id
-      @name     = file_name
-      @basename = File.basename(file_name)
+    def update_if_need
+      if need_to_update?
+        result = update
+        puts "Updated `#{file_path}` to #{result.html_url}"
+      elsif GistUpdater.debug
+        puts "There was no need to update `#{file_path}`."
+      end
+
+      result
+    end
+
+    private
+
+    attr_reader :user, :access_token, :gist_id, :file_path
+
+    def client
+      @client ||= Octokit::Client.new(login: user, access_token: access_token)
+    end
+
+    def need_to_update?
+      @need_to_update ||= gist != local
     end
 
     def gist
-      @gist ||= client.gist(gist_id).files[basename].content
+      @gist ||= client.gist(gist_id).files[file_name].content
     end
 
     def local
-      @local ||= File.read(name)
+      @local ||= File.read(file_path)
     end
 
     def update
-      result = client.edit_gist(
+      client.edit_gist(
         gist_id,
-        files: { basename => { 'content' => local } }
+        files: { file_name => { 'content' => local } }
       )
-      puts "Updated `#{name}` to #{result.html_url}"
-      result
     end
 
-    private
-
-    attr_reader :client, :gist_id, :basename
+    def file_name
+      @file_name ||= File.basename(file_path)
+    end
   end
 end

data/lib/gist_updater/debug.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module GistUpdater
+  class << self
+    attr_accessor :debug
+  end
+end

data/lib/gist_updater/updater.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GistUpdater
+  class Updater
+    def initialize(options, config_class = Config)
+      @user             = options[:user] || ENV['GISTUPDATER_USER']
+      @access_token     = options[:token] || ENV['GISTUPDATER_ACCESS_TOKEN']
+      @config           = config_class.new(options[:yaml])
+      GistUpdater.debug = options[:debug]
+    end
+
+    def update
+      count = 0
+
+      config.each do |gist_id, file_path|
+        count += 1 if update_1(gist_id, file_path)
+      end
+
+      count
+    end
+
+    private
+
+    attr_reader :user, :access_token, :config
+
+    def update_1(gist_id, file_path)
+      Content.new(
+        user: user,
+        access_token: access_token,
+        gist_id: gist_id,
+        file_path: file_path
+      ).update_if_need
+    end
+  end
+end

data/lib/gist_updater/version.rb

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

data/lib/gist_updater.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'gist_updater/commands'
+require 'gist_updater/config'
 require 'gist_updater/content'
-require 'gist_updater/content_factory'
+require 'gist_updater/debug'
+require 'gist_updater/updater'
 require 'gist_updater/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gist_updater
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Takashi Masuda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-24 00:00:00.000000000 Z
+date: 2016-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -121,8 +121,10 @@ files:
 - gist_updater.yml.example
 - lib/gist_updater.rb
 - lib/gist_updater/commands.rb
+- lib/gist_updater/config.rb
 - lib/gist_updater/content.rb
-- lib/gist_updater/content_factory.rb
+- lib/gist_updater/debug.rb
+- lib/gist_updater/updater.rb
 - lib/gist_updater/version.rb
 homepage: https://github.com/masutaka/gist_updater
 licenses:

data/lib/gist_updater/content_factory.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module GistUpdater
-  class ContentFactory
-    def self.build(user, access_token, config, content_class = Content)
-      content_class.new(
-        user: user,
-        access_token: access_token,
-        gist_id: config[0],
-        file_name: config[1]
-      )
-    end
-  end
-end