whatsnew 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a219950a9a69efe9a80a642981f63e71b42a8cca
-  data.tar.gz: ac3290929b7c929d2a839adccf34a0de8d9a3237
+  metadata.gz: 8e65b62f957e1db459c711ace3bffe378b45dbcf
+  data.tar.gz: ac629b4ff791f3c34e8cabdf0f22c0df9ac0115f
 SHA512:
-  metadata.gz: 3737fe2813a30bbb0e5de036bcea21a6aac8b895b6684f76c0b111e4c258667f97e86902fb741982695a5ae4ffb723cc830161dee9f4bc6b6b785274266a8a70
-  data.tar.gz: 9d8a0d1708a8bbff80248f12afbbb11b4a99ce0e845d3f290a063cc332832187fdecdd3b9b2004e5411dba050140e2b8426e35b39ad10f8df162ffe5581f1b92
+  metadata.gz: 24336375d94687abae9b7b40a185efa2c2fd098ff654a0807777d10cc7447b81f5ad8cdee368e839f393cae2df52c37ac02eb9ebf6ed3ac126dc1295ece21bd9
+  data.tar.gz: 685cfc1708993d40744908ff31509c4c4c761f3c62b2f121ef14c9e9aa5a92f34b42c0b5c18e8cb7bfcc899e392c13f52fcb02b3ab5c63914e76cdb1fdeb615d

data/.travis.yml

@@ -12,4 +12,4 @@ matrix:
   fast_finish: true
 notifications:
   slack:
-    secure: wZ1UPEcH/Zf/wSPvpR1q76vpUQvAEGuwR5500ML8C+shW7PedvuSZaiZYAOZxhyD17RXzXYroON0ArEk3NUcKD8supPzYjUWzCeWDIFaYxEb7dOm7tpRBf4GuQ/oy8HGsBi947ZTX3WytGWZU0q0aRu2EirPcoY05vzley/hYTI=
+    secure: B25UgGnWzd/gLr97Ac233rhp7bV3FnmbmuYU9KGLa7s8YTmdKnHg5ASOl3NEdDRSZwhhQvMF6FRhqLvQenFsIYn9f9qSmY0+d5/gB8iUQkGAIXIx0VFrPhO6ZTefEJ2uhPyKtZIkzEOVD9jo4w5Kh9XvUPFY1v8OM+wz+8cW28G+fS1gof+yJUBVQb7/FGSzc2nxDvCwcU2pYeQ2rUnugDc8wfcQYCsp+MU+qBTsotTBCiGqrZWouqi3dWbMPHqeaW8B343+jviM0LgvyEF6klw0dR218SRWlavYjZq6w4yEwtPI+Wl0jXe06DcbISBQwKRH4ljwT2Qvx0gjIEG9fKo7Gl59gg/U3p3wZixV/O1/f0oDgVO1FZIMHP0CVWX8+VV/g4ru/jVp0R74Mfq3mIhSh1z7iMgFMoVMzOLJq8nDPQWPi+1Wc5z1AeCnC1bjcwhN07FzIHq3GTuqjLGRNfm5nvG8PCsw0dgsV9z826teHJrXJz8mApGZZR6WvWdSqWdUaIxtHoeuaBd+7/iqxYKdW8uov4U7Vc4gFqs36SmNtrRf1fnVs/p0QM4SbPo+KYROin7oZTngMLVJ2qLYhTMWpszJfnpFl2ZHYlfTF2rHUaBioOnagAqs1iiVp51mX2brXnjUdQWGbGuEryrO88qZ5tS6DnfS4+A57cgloe8=

data/CHANGELOG.md

@@ -2,9 +2,17 @@
 
 ## Unrelease
 
+## v0.4.0 - 2015-08-09
+
+### API CHANGES
+
+- `NewsFile#content` => `NewsFile#read` [#4](https://github.com/jollygoodcode/whatsnew/pull/4)
+- `NewsFile#content` => The content of the news file [#4](https://github.com/jollygoodcode/whatsnew/pull/4)
+- Refactor the internal classes interfaces [#3](https://github.com/jollygoodcode/whatsnew/pull/3)
+
 ## v0.3.0 - 2015-08-09
 
-- API Support finding news file from Octokit response
+- API Support finding news file from Octokit response [#1](https://github.com/jollygoodcode/whatsnew/pull/1)
 
 ## v0.2.0 - 2015-08-08
 

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/whatsnew.svg)](http://badge.fury.io/rb/whatsnew)
 [![Build Status](https://travis-ci.org/jollygoodcode/whatsnew.svg?branch=master)](https://travis-ci.org/jollygoodcode/whatsnew)
 
-What's New of a project?
+What's New about a project?
 
 --
 
@@ -36,7 +36,7 @@ What's New:
 See CHANGELOG.md: https://github.com/jollygoodcode/whatsnew/blob/master/CHANGELOG.md.
 ```
 
-### Local API usage
+### API usage for Local Files
 
 ```ruby
 news = Whatsnew.about "/Users/Juan/dev/whatsnew"
@@ -47,13 +47,15 @@ news.file_name
 news.file_url
 => "https://github.com/jollygoodcode/whatsnew/blob/master/CHANGELOG.md"
 
-news.content
+news.read
 => "What's New:\nSee CHANGELOG.md: https://github.com/jollygoodcode/whatsnew/blob/master/CHANGELOG.md."
 ```
 
-### Remote API usage with [Octokit](https://github.com/octokit/octokit.rb)
+### API usage for Remote Files
 
-First [get an OAuth access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/), then:
+#### Example use with [Octokit](https://github.com/octokit/octokit.rb)
+
+First [get an access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/), then:
 
 ```ruby
 client = Octokit::Client.new(access_token: ENV["OAUTH_TOKEN"])
@@ -66,10 +68,27 @@ news.file_name
 news.file_url
 => "https://github.com/jollygoodcode/whatsnew/blob/master/CHANGELOG.md"
 
-news.content
+news.read
 => "What's New:\nSee CHANGELOG.md: https://github.com/jollygoodcode/whatsnew/blob/master/CHANGELOG.md."
 ```
 
+Note that you can pass in array of any objects to `Whatsnew.about`, each object must respond to `:name` and `:html_url` messages:
+
+```ruby
+Resource = Struct.new(:name, :html_url)
+
+news = Whatsnew.about [Resource.new("NEWS", "https://github.com/ruby/ruby/blob/trunk/NEWS")]
+
+news.file_name
+=> "NEWS"
+
+news.file_url
+=> "https://github.com/ruby/ruby/blob/trunk/NEWS"
+
+news.read
+=> "What's New:\nSee NEWS: https://github.com/ruby/ruby/blob/trunk/NEWS."
+```
+
 
 ## What it searches for?
 
@@ -85,6 +104,10 @@ See [DEVELOPMENT.md](DEVELOPMENT.md).
 
 See [CONTRIBUTING.md](CONTRIBUTING.md).
 
+## Inspired by
+
+[benbalter/licensee](https://github.com/benbalter/licensee) - A RubyGem to detect under what license a project is distributed.
+
 ## Credits
 
 A huge THANK YOU to all our [contributors](https://github.com/jollygoodcode/whatsnew/graphs/contributors)! :heart:

data/bin/whatsnew

@@ -6,7 +6,7 @@ require "bundler/setup"
 require "whatsnew"
 
 if news = Whatsnew.about(Dir.pwd)
-  puts news.content
+  puts news.read
 else
   puts "Not found. Do you mind keep a changelog?"
   puts "Or tell the project owner to keep a changelog :)"

data/lib/whatsnew/local_files.rb

@@ -0,0 +1,52 @@
+require "pathname"
+
+module Whatsnew
+  class LocalFiles
+    def initialize(path)
+      @path = path
+      @news = Dir.glob(File.join(path, "*".freeze)).find do |file|
+        file =~ %r{(CHANGE|CHANGES|CHANGELOG|NEWS|HISTORY)}i.freeze
+      end
+    end
+
+    def to_news_file
+      if news
+        NewsFile.new(
+          file_name,
+          content: file.read,
+          file_url: "#{project_uri}/blob/master/#{file_name}"
+        )
+      else
+        NoNewsFile.new
+      end
+    end
+
+    private
+
+      attr_reader :path, :news, :matched
+
+      def project_uri
+        if File.exist?("#{path}/.git") && matched_from_git_config
+          "https://#{matched[:host]}/#{matched[:owner]}/#{matched[:repo]}"
+        else
+          "NOT FOUND".freeze
+        end
+      end
+
+      def matched_from_git_config
+        @matched ||= Dir.chdir(Pathname(path).to_path) do
+          `git config --get remote.origin.url`.match(
+            %r{git.+(?<host>(github.com|bitbucket.com|bitbucket.org))[:/](?<owner>\S+)/(?<repo>\S+)\.git}
+          )
+        end
+      end
+
+      def file
+        @file ||= Pathname(news)
+      end
+
+      def file_name
+        @file_name ||= file.basename.to_s
+      end
+  end
+end

data/lib/whatsnew/news_file.rb

@@ -2,23 +2,16 @@ require "pathname"
 
 module Whatsnew
   class NewsFile
-    attr_reader :file_url
+    attr_reader :file_name, :content, :file_url
 
-    def initialize(path, project_uri)
-      @newsfile = Pathname(path)
-      @file_url = "#{project_uri}/blob/master/#{file_name}"
+    def initialize(file_name, content: nil, file_url: nil)
+      @file_name = file_name
+      @content = content
+      @file_url = file_url
     end
 
-    def content
+    def read
       "What's New:\n" "See #{file_name}: #{file_url}."
     end
-
-    def file_name
-      newsfile.basename.to_s
-    end
-
-    private
-
-      attr_reader :newsfile
   end
 end

data/lib/whatsnew/no_news_file.rb

@@ -4,16 +4,20 @@ module Whatsnew
   class NoNewsFile
     NOT_FOUND = "NOT FOUND".freeze
 
-    def content
+    def file_name
       NOT_FOUND
     end
 
-    def file_name
+    def file_url
       NOT_FOUND
     end
 
-    def file_url
+    def read
       NOT_FOUND
     end
+
+    def content
+      "".freeze
+    end
   end
 end

data/lib/whatsnew/project.rb

@@ -1,56 +1,25 @@
-require "pathname"
-
 module Whatsnew
   class Project
     attr_reader :news_file
 
-    def initialize(path)
-      @path = path
-      @news_file = get_news_file_from_path
-    end
-
-    def get_news_file_from_path
-      if path_is_a_sawyer_resource_array
-        RemoteNewsFile.new(path)
-      else
-        if news_file_name
-          NewsFile.new(news_file_name, project_uri)
-        else
-          NoNewsFile.new
-        end
-      end
-    end
+    def initialize(path_or_resources)
+      @path_or_resources = Array(path_or_resources)
 
-    # git@github.com:jollygoodcode/whatsnew.git
-    # => https://github.com:jollygoodcode/whatsnew
-    def project_uri
-      if matched = matched_from_git_repository
-        "https://#{matched[:host]}/#{matched[:owner]}/#{matched[:repo]}"
+      @news_file = if resources?
+        RemoteFiles.new(path_or_resources).to_news_file
       else
-        "NOT FOUND".freeze
+        LocalFiles.new(path_or_resources).to_news_file
       end
     end
 
     private
 
-      attr_reader :path
-
-      def path_is_a_sawyer_resource_array
-        path.is_a?(Array) && path.first.is_a?(Sawyer::Resource)
-      end
-
-      def news_file_name
-        @news_file_name ||= Dir.glob(File.join(path, "*".freeze)).find do |file|
-          file =~ %r{(CHANGE|CHANGES|CHANGELOG|NEWS|HISTORY)}i.freeze
-        end
-      end
+      attr_reader :path_or_resources
 
-      def matched_from_git_repository
-        Dir.chdir(Pathname(path).to_path) do
-          `git config --get remote.origin.url`.match(
-            %r{git.+(?<host>(github.com|bitbucket.com|bitbucket.org))[:/](?<owner>\S+)/(?<repo>\S+)\.git}
-          )
-        end
+      def resources?
+        path_or_resources &&
+        path_or_resources.first.respond_to?(:name) &&
+        path_or_resources.first.respond_to?(:html_url)
       end
   end
 end

data/lib/whatsnew/remote_files.rb

@@ -0,0 +1,25 @@
+module Whatsnew
+  class RemoteFiles
+    def initialize(resources)
+      @news = resources.find do |resource|
+        resource.name =~ %r{(CHANGE|CHANGES|CHANGELOG|NEWS|HISTORY)}i.freeze
+      end
+    end
+
+    def to_news_file
+      if news
+        NewsFile.new(news.name, content: "See #{news_html_url}", file_url: news_html_url)
+      else
+        NoNewsFile.new
+      end
+    end
+
+    private
+
+      attr_reader :news
+
+      def news_html_url
+        @news_html_url ||= news.html_url
+      end
+  end
+end

data/lib/whatsnew/version.rb

@@ -1,3 +1,3 @@
 module Whatsnew
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/whatsnew.rb

@@ -1,11 +1,13 @@
 require "whatsnew/version"
-require "whatsnew/remote_news_file"
+require "whatsnew/remote_files"
+require "whatsnew/local_files"
 require "whatsnew/news_file"
 require "whatsnew/no_news_file"
 require "whatsnew/project"
 
 module Whatsnew
-  def self.about(path)
-    Whatsnew::Project.new(path).news_file
+  # Each resource must respond to message :name and :html.
+  def self.about(path_or_resources)
+    Whatsnew::Project.new(path_or_resources).news_file
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whatsnew
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Juanito Fatas
@@ -30,10 +30,11 @@ files:
 - bin/dev
 - bin/whatsnew
 - lib/whatsnew.rb
+- lib/whatsnew/local_files.rb
 - lib/whatsnew/news_file.rb
 - lib/whatsnew/no_news_file.rb
 - lib/whatsnew/project.rb
-- lib/whatsnew/remote_news_file.rb
+- lib/whatsnew/remote_files.rb
 - lib/whatsnew/version.rb
 - whatsnew.gemspec
 homepage: https://github.com/jollygoodcode/whatsnew

data/lib/whatsnew/remote_news_file.rb

@@ -1,27 +0,0 @@
-require "pathname"
-
-module Whatsnew
-  class RemoteNewsFile
-    def initialize(sawyer_resources)
-      @news_resource = sawyer_resources.find do |resource|
-        resource.name =~ %r{(CHANGE|CHANGES|CHANGELOG|NEWS|HISTORY)}i.freeze
-      end
-    end
-
-    def content
-      "What's New:\n" "See #{file_name}: #{file_url}."
-    end
-
-    def file_name
-      news_resource.name
-    end
-
-    def file_url
-      news_resource.html_url
-    end
-
-    private
-
-      attr_reader :news_resource
-  end
-end