whatsnew 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a219950a9a69efe9a80a642981f63e71b42a8cca
+  data.tar.gz: ac3290929b7c929d2a839adccf34a0de8d9a3237
+SHA512:
+  metadata.gz: 3737fe2813a30bbb0e5de036bcea21a6aac8b895b6684f76c0b111e4c258667f97e86902fb741982695a5ae4ffb723cc830161dee9f4bc6b6b785274266a8a70
+  data.tar.gz: 9d8a0d1708a8bbff80248f12afbbb11b4a99ce0e845d3f290a063cc332832187fdecdd3b9b2004e5411dba050140e2b8426e35b39ad10f8df162ffe5581f1b92

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+sudo: false
+bundler_args: "--retry=3 --jobs=3"
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+notifications:
+  slack:
+    secure: wZ1UPEcH/Zf/wSPvpR1q76vpUQvAEGuwR5500ML8C+shW7PedvuSZaiZYAOZxhyD17RXzXYroON0ArEk3NUcKD8supPzYjUWzCeWDIFaYxEb7dOm7tpRBf4GuQ/oy8HGsBi947ZTX3WytGWZU0q0aRu2EirPcoY05vzley/hYTI=

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# CHANGELOG
+
+## Unrelease
+
+## v0.3.0 - 2015-08-09
+
+- API Support finding news file from Octokit response
+
+## v0.2.0 - 2015-08-08
+
+- NewsFile API changes
+
+### Features
+
+- Add `bin/dev` script for development
+
+### Bug Fixes
+
+- Fix matching git repository
+- Fix search for a git repo without news file
+
+## v0.1.0 - 2015-08-08
+
+Project init. Can detect a local project's news file location.

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing
+
+1. Fork it ( https://github.com/jollygoodcode/whatsnew/fork )
+2. Create your feature branch ( `git checkout -b my-new-feature` )
+3. Commit your changes ( `git commit -am 'Add some feature'` )
+4. Push to the branch ( `git push origin my-new-feature` )
+5. Create a new Pull Request

data/DEVELOPMENT.md

@@ -0,0 +1,13 @@
+# Development
+
+## Install Dependencies
+
+    $ bundle
+
+## Running Tests
+
+    $ bundle exec rake
+
+## Run with local gem
+
+    $ bin/dev

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "bundler"
+gem "rake"
+gem "pry"
+gem "minitest", "~> 5.8"
+gem "shoulda", "~> 3.5"
+gem "octokit", "~> 4.0.1"
+gem "dish"

data/LICENSE.md

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

@@ -0,0 +1,96 @@
+# What's New?
+
+[![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?
+
+--
+
+Where is the document which documents changes between two releases?
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "whatsnew"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install whatsnew
+
+## Usage
+
+### Command line usage
+
+```
+$ whatsnew
+
+What's New:
+See CHANGELOG.md: https://github.com/jollygoodcode/whatsnew/blob/master/CHANGELOG.md.
+```
+
+### Local API usage
+
+```ruby
+news = Whatsnew.about "/Users/Juan/dev/whatsnew"
+
+news.file_name
+=> "CHANGELOG.md"
+
+news.file_url
+=> "https://github.com/jollygoodcode/whatsnew/blob/master/CHANGELOG.md"
+
+news.content
+=> "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)
+
+First [get an OAuth 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"])
+
+news = Whatsnew.about client.contents("jollygoodcode/whatsnew")
+
+news.file_name
+=> "CHANGELOG.md"
+
+news.file_url
+=> "https://github.com/jollygoodcode/whatsnew/blob/master/CHANGELOG.md"
+
+news.content
+=> "What's New:\nSee CHANGELOG.md: https://github.com/jollygoodcode/whatsnew/blob/master/CHANGELOG.md."
+```
+
+
+## What it searches for?
+
+* `CHANGELOG`, `CHANGE`, `CHANGES`, `HISTORY`, `NEWS` in the root of project (regardless of file extension).
+
+* It doesn't search for changelog listed in README.
+
+## Development
+
+See [DEVELOPMENT.md](DEVELOPMENT.md).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Credits
+
+A huge THANK YOU to all our [contributors](https://github.com/jollygoodcode/whatsnew/graphs/contributors)! :heart:
+
+This project is maintained by [Jolly Good Code](http://www.jollygoodcode.com).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.md).

data/Rakefile

@@ -0,0 +1,10 @@
+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 default: :test

data/bin/dev

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "whatsnew"
+
+require "octokit"
+
+require "pry"
+Pry.start

data/bin/whatsnew

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+Signal.trap("INT") { abort }
+
+require "bundler/setup"
+require "whatsnew"
+
+if news = Whatsnew.about(Dir.pwd)
+  puts news.content
+else
+  puts "Not found. Do you mind keep a changelog?"
+  puts "Or tell the project owner to keep a changelog :)"
+  puts "See http://keepachangelog.com"
+end

data/lib/whatsnew/news_file.rb

@@ -0,0 +1,24 @@
+require "pathname"
+
+module Whatsnew
+  class NewsFile
+    attr_reader :file_url
+
+    def initialize(path, project_uri)
+      @newsfile = Pathname(path)
+      @file_url = "#{project_uri}/blob/master/#{file_name}"
+    end
+
+    def content
+      "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

@@ -0,0 +1,19 @@
+require "pathname"
+
+module Whatsnew
+  class NoNewsFile
+    NOT_FOUND = "NOT FOUND".freeze
+
+    def content
+      NOT_FOUND
+    end
+
+    def file_name
+      NOT_FOUND
+    end
+
+    def file_url
+      NOT_FOUND
+    end
+  end
+end

data/lib/whatsnew/project.rb

@@ -0,0 +1,56 @@
+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
+
+    # 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]}"
+      else
+        "NOT FOUND".freeze
+      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
+
+      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
+      end
+  end
+end

data/lib/whatsnew/remote_news_file.rb

@@ -0,0 +1,27 @@
+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

data/lib/whatsnew/version.rb

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

data/lib/whatsnew.rb

@@ -0,0 +1,11 @@
+require "whatsnew/version"
+require "whatsnew/remote_news_file"
+require "whatsnew/news_file"
+require "whatsnew/no_news_file"
+require "whatsnew/project"
+
+module Whatsnew
+  def self.about(path)
+    Whatsnew::Project.new(path).news_file
+  end
+end

data/whatsnew.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "whatsnew/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "whatsnew"
+  spec.version       = Whatsnew::VERSION
+  spec.authors       = ["Juanito Fatas"]
+  spec.email         = ["katehuang0320@gmail.com"]
+
+  spec.summary       = %q{Find out what's new about a project}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/jollygoodcode/whatsnew"
+  spec.license       = "MIT"
+
+  spec.bindir = "bin"
+  spec.executables << "whatsnew"
+
+  spec.require_paths = ["lib"]
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: whatsnew
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Juanito Fatas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-09 00:00:00.000000000 Z
+dependencies: []
+description: Find out what's new about a project
+email:
+- katehuang0320@gmail.com
+executables:
+- whatsnew
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- DEVELOPMENT.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/dev
+- bin/whatsnew
+- lib/whatsnew.rb
+- lib/whatsnew/news_file.rb
+- lib/whatsnew/no_news_file.rb
+- lib/whatsnew/project.rb
+- lib/whatsnew/remote_news_file.rb
+- lib/whatsnew/version.rb
+- whatsnew.gemspec
+homepage: https://github.com/jollygoodcode/whatsnew
+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.8
+signing_key: 
+specification_version: 4
+summary: Find out what's new about a project
+test_files: []
+has_rdoc: