awesome_bot 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8feb264201072a97f70c9146f636d95bcd5fca77
-  data.tar.gz: 5762b4ef3b0584cd155b87dd3ba81cb5347f6a1d
+  metadata.gz: 4c6768985f4950e9e02cd32463e1f160b9dc0900
+  data.tar.gz: b32f892d1dcbb164b14a91a860000c39dd23cd44
 SHA512:
-  metadata.gz: 00f748d97bc39f0ad148288611ed8252dc0d1f242da3b948146a0cae7e3c373063fc9df67f14990dff622e9ae01b81934018a00b28931d2a425ac643d3df8dd1
-  data.tar.gz: 023bad1bc68ee5b59915ac10cd2ccad6fe3d77626318b886fe8a1ad5c3da1bd51d1707020d2396165589e3efe54d725816b7d35706c66d734c94c3a790555840
+  metadata.gz: 758801b59a894c8f59f6b11238b7b73e302202a32991b924d9c20bc884a0355197c5a969454e731e8c5559df2b109837cb66f5dcd319e6e1706add98ee1c6355
+  data.tar.gz: 1d5ba3c19898eae9e252bdcc2344798f5af89400d0f7c79f528b86eed88f16e9fe4b573830dbe5ad95b296d3dbc819a41f79635a1b453c7019f36416fbbce779

data/.travis.yml

@@ -8,4 +8,4 @@ script:
   - awesome_bot bin/assets/test-no-issues
   - awesome_bot bin/assets/test-no-links
   - awesome_bot bin/assets/test-dupe --allow-dupe
-  - awesome_bot README.md --allow-dupe --white-list gph.is,bot.svg,codeload,badge
+  - awesome_bot README.md --allow-dupe --white-list gph.is,bot.svg,codeload,badge,rubydoc

data/CHANGELOG.md

@@ -20,6 +20,13 @@
 - add head option when getting statuses
 - [cli] improve output for `--allow-dupe`
 
+# 1.2.0
+
+- move some logic from check to cli
+- output status for white listed links
+- use `result`
+- use `logger`
+
 ## Contact
 
 - [github.com/dkhamsing](https://github.com/dkhamsing)

data/README.md

@@ -33,12 +33,11 @@ irb(main):001:0> require 'awesome_bot'
 irb(main):002:0> c = File.read 'README.md'
 => "..."
 irb(main):003:0> AwesomeBot.check c
-=> [false, [{"url"=>"http://gph.is/1gU5itl", "status"=>301},..]
-# returning false, statuses and dupes if there are errors
-# otherwise returning true
+=> #<AwesomeBot::Result:0x007fdde39f4408 @links=...>
+# AwesomeBot Result with success, statuses_issues, dupes and more
 ```
 
-More information at [rubydoc](http://www.rubydoc.info/gems/awesome_bot/1.1.0).
+More information at [rubydoc](http://www.rubydoc.info/gems/awesome_bot).
 
 ### Command Line
 

data/lib/awesome_bot/check.rb

@@ -1,6 +1,7 @@
 require 'awesome_bot/links'
+require 'awesome_bot/log'
+require 'awesome_bot/result'
 require 'awesome_bot/statuses'
-require 'awesome_bot/white_list'
 
 # Check links
 module AwesomeBot
@@ -10,71 +11,43 @@ module AwesomeBot
   STATUS_OTHER = 'x'
 
   class << self
-    def check(content, white_listed = nil, skip_dupe = false, verbose = false)
-      dupe_success = skip_dupe
+    def check(content, white_listed = nil, skip_dupe = false, log = Log.new)
+      log.add '> Will allow duplicate links' if skip_dupe
 
-      puts '> Will allow duplicate links' if skip_dupe && verbose
+      temp = links_filter(links_find(content))
 
-      white_listing = !white_listed.nil?
-      puts "> White list: #{white_listed.join ', '}" if white_listing && verbose
+      r = Result.new(temp, white_listed)
+      r.skip_dupe = skip_dupe
 
-      links = links_filter(links_find(content))
+      log.add "> White list: #{white_listed.join ', '}" if r.white_listing
 
-      if white_listing
-        rejected, links = links.partition { |u| white_list white_listed, u }
-      end
-
-      if verbose
-        print "Links found: #{links.count}"
-        print ", #{rejected.count} white listed" if white_listing
-        print ", #{links.uniq.count} unique" if links.count != links.uniq.count
-        puts ''
-        links.uniq.each_with_index { |u, j| puts "  #{j + 1}. #{u}" }
-      end
-
-      print 'Checking URLs: ' if verbose && (links.count > 0)
-      statuses =
-        statuses(links.uniq, NUMBER_OF_THREADS) do |s|
-          print(s == 200 ? STATUS_OK : STATUS_OTHER) if verbose
-        end
-      puts '' if verbose
-
-      statuses_issues = statuses.select { |x| x['status'] != 200 }
-      links_success = statuses_issues.count == 0
+      r.dupes = r.links.select { |e| r.links.count(e) > 1 } unless skip_dupe
 
+      log.addp "Links found: #{r.links.count}"
+      log.addp ", #{r.rejected.count} white listed" if r.white_listing
       unless skip_dupe
-        dupe_success = links.uniq.count == links.count
-        dupes = links.select { |e| links.count(e) > 1 }
-      end
-
-      if links_success && dupe_success
-        puts 'No issues :-)' if verbose
-        return true
+        log.addp ", #{r.links.uniq.count} unique" if r.dupes.count > 0
       end
+      log.add ''
+      r.links.uniq.each_with_index { |u, j| log.add "  #{j + 1}. #{u}" }
 
-      if verbose
-        puts "\nIssues :-("
-
-        print "> Links \n"
-        if links_success
-          puts "  All OK #{STATUS_OK}"
-        else
-          statuses_issues.each_with_index do |x, k|
-            puts "  #{k + 1}. #{x['status']}: #{x['url']} "
-          end
+      log.addp 'Checking URLs: ' if r.links.count > 0
+      r.status =
+        statuses(r.links.uniq, NUMBER_OF_THREADS) do |s|
+          log.addp(s == 200 ? STATUS_OK : STATUS_OTHER)
         end
+      log.add ''
+
+      return r if !r.white_listing || (r.rejected.count > 0)
 
-        unless skip_dupe
-          print "> Dupes \n"
-          if dupe_success
-            puts "  None #{STATUS_OK}"
-          else
-            dupes.uniq.each_with_index { |d, m| puts "  #{m + 1}. #{d}" }
-          end
+      log.addp 'Checking white listed URLs: '
+      r.white_listed =
+        statuses(r.rejected.uniq, NUMBER_OF_THREADS, true) do |s|
+          log.addp(s == 200 ? STATUS_OK : STATUS_OTHER)
         end
-      end # if verbose
+      log.add ''
 
-      [false, statuses, dupes]
-    end # run
+      r
+    end # check
   end # class
 end

data/lib/awesome_bot/cli.rb

@@ -1,3 +1,6 @@
+require 'awesome_bot/check'
+require 'awesome_bot/log'
+require 'awesome_bot/result'
 require 'awesome_bot/version'
 
 # Command line interface
@@ -43,9 +46,42 @@ module AwesomeBot
         exit 1
       end
 
-      exit 1 unless check(content, white_listed, skip_dupe, true) == true
+      log = Log.new(true)
+      r = check(content, white_listed, skip_dupe, log)
 
-      exit
+      unless r.white_listed.nil?
+        puts "\n> White listed:"
+        r.white_listed.each_with_index do |x, k|
+          puts "  #{k + 1}. #{x['status']}: #{x['url']} "
+        end
+      end
+
+      if r.success == true
+        puts 'No issues :-)'
+        # exit ?
+      else
+        puts "\nIssues :-("
+
+        print "> Links \n"
+        if r.success_links
+          puts "  All OK #{STATUS_OK}"
+        else
+          r.statuses_issues.each_with_index do |x, k|
+            puts "  #{k + 1}. #{x['status']}: #{x['url']} "
+          end
+        end
+
+        unless skip_dupe
+          print "> Dupes \n"
+          if r.success_dupe
+            puts "  None #{STATUS_OK}"
+          else
+            r.dupes.uniq.each_with_index { |d, m| puts "  #{m + 1}. #{d}" }
+          end
+        end
+
+        exit 1
+      end
     end
   end # class
 end

data/lib/awesome_bot/log.rb

@@ -0,0 +1,17 @@
+# Log
+module AwesomeBot
+  # Log
+  class Log
+    def initialize(verbose = false)
+      @v = verbose
+    end
+
+    def add(message)
+      puts message if @v
+    end
+
+    def addp(message)
+      print message if @v
+    end
+  end # class
+end

data/lib/awesome_bot/result.rb

@@ -0,0 +1,44 @@
+require 'awesome_bot/white_list'
+
+# Result
+module AwesomeBot
+  # Result
+  class Result
+    attr_accessor :dupes
+    attr_accessor :skip_dupe
+    attr_accessor :status
+    attr_accessor :white_listed
+
+    attr_reader :rejected
+    attr_reader :links
+
+    def initialize(links, white_list_from_cli)
+      @links = links
+      @w = white_list_from_cli
+
+      return if @w.nil?
+      @rejected, @links = links.partition { |u| AwesomeBot.white_list @w, u }
+    end
+
+    def statuses_issues
+      status.select { |x| x['status'] != 200 }
+    end
+
+    def success
+      success_dupe && success_links
+    end
+
+    def success_dupe
+      return true if skip_dupe
+      links.uniq.count == links.count
+    end
+
+    def success_links
+      statuses_issues.count == 0
+    end
+
+    def white_listing
+      !@w.nil?
+    end
+  end # class
+end

data/lib/awesome_bot/version.rb

@@ -5,5 +5,5 @@ module AwesomeBot
                         'Great for "awesome" projects.'
   PROJECT_URL = 'https://github.com/dkhamsing/awesome_bot'
 
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awesome_bot
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Daniel Khamsing
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -95,6 +95,8 @@ files:
 - lib/awesome_bot/check.rb
 - lib/awesome_bot/cli.rb
 - lib/awesome_bot/links.rb
+- lib/awesome_bot/log.rb
+- lib/awesome_bot/result.rb
 - lib/awesome_bot/statuses.rb
 - lib/awesome_bot/version.rb
 - lib/awesome_bot/white_list.rb