katip 1.4.1 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 360db67152a822892b356b20e998d19c113366b5
-  data.tar.gz: 51cee3f1a75cbc45999eaf33a6658af2bfb76bf9
+  metadata.gz: 16ad82df25aa8c27b2eca4b0c2b7baa5c2981c99
+  data.tar.gz: fc18bf916dd3b1dd4d254d39e1bca5d3dc36b38e
 SHA512:
-  metadata.gz: 235e61046562d53c8197d22aed59f69555bd7fe0f0216cd490a95fc14e781c961b4ebb67d342bac924c6576363d5560a0b47e4c997f14c6c9d51800504757a41
-  data.tar.gz: 509edfe9e673b67b4f99ffcaff0287a17f81aff4330acaaba74a6ea78e45f392c778edb14111cffc33d662d543412ce1debc2ee79353192e2b5f1bae338bd31e
+  metadata.gz: bea5652bdcfa2ece803943adb3d4ff144dd5564c5a7785f9a093a3b5e56612d2d47736fb5f3bcaa84509d3656863e5e40c23910eba937c1e91e0bae7fc3bd2fb
+  data.tar.gz: 190d15fd89909e9f44c479b5e171b60def3630d3e528c13798be47c5f86f344232064eaef49ba54a3bd94d38bb09722b4618eed34185d7daa450d0e86328bd6a

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "spec/katip-sample-repo"]
+	path = spec/katip-sample-repo
+	url = git://github.com/lab2023/katip-sample-repo

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 
 #### [Current]
+ * [2191cbf](../../commit/2191cbf) - __(Ahmet Sezgin Duran)__ TB-46 #time 5m Fix condition errors
+ * [544b0ea](../../commit/544b0ea) - __(Ahmet Sezgin Duran)__ TB-46 #time 10m Fix the tag not found error
+
+#### 1.5.0
+ * [b3e600f](../../commit/b3e600f) - __(Ahmet Sezgin Duran)__ TB-46 #time 5m Bump version 1.5.0 and update README
+ * [310024d](../../commit/310024d) - __(Ahmet Sezgin Duran)__ TB-46 #time 15m Add option parse for Katip
+ * [e1d8eae](../../commit/e1d8eae) - __(Ahmet Sezgin Duran)__ TB-46 #time 5m Fix test result files
+ * [72db774](../../commit/72db774) - __(Ahmet Sezgin Duran)__ Add new sample repo submodule
+ * [b397a22](../../commit/b397a22) - __(Ahmet Sezgin Duran)__ Remove sample repo submodule
+ * [d4788d6](../../commit/d4788d6) - __(Ahmet Sezgin Duran)__ TB-46 #time 15m Implement change logging with ending tag
+ * [b2e8163](../../commit/b2e8163) - __(Ahmet Sezgin Duran)__ TB-46 #time 5m Implement the basic tag range logging
+ * [94e3c7d](../../commit/94e3c7d) - __(Ahmet Sezgin Duran)__ TB-46 #time 5m Add tag range test
+ * [fe8caf7](../../commit/fe8caf7) - __(Ahmet Sezgin Duran)__ TB-46 #time 15m Add basic tests
+ * [75e9d4c](../../commit/75e9d4c) - __(Ahmet Sezgin Duran)__ TB-46 #time 5m Add RSpec for testing
+ * [33ecf6b](../../commit/33ecf6b) - __(Ahmet Sezgin Duran)__ TB-46 #time 5m Add sample repo as submodule
+ * [8d3a0b1](../../commit/8d3a0b1) - __(Ahmet Sezgin Duran)__ LAB-31 #time 1 Add named logo
+ * [9c7e65c](../../commit/9c7e65c) - __(Ahmet Sezgin Duran)__ LAB-31 #time 1m Fix year information in README.md and license
+ * [195e061](../../commit/195e061) - __(Ahmet Sezgin Duran)__ LAB-31 #time 2m Update README.md
+
+#### 1.4.1
+ * [1629eb6](../../commit/1629eb6) - __(Murat Kemal BAYGÜN)__ Release 1.4.1
  * [f8b07a7](../../commit/f8b07a7) - __(Onur Özgür ÖZKAN)__ Merge pull request [#27](../../issues/27) from marjinal1st/feature/WithoutRails
 
 TB-11 #time 15m Use Katip without Rails

data/Gemfile.lock

@@ -1,12 +1,25 @@
 PATH
   remote: .
   specs:
-    katip (1.4.0)
+    katip (1.5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    diff-lcs (1.2.5)
     rake (10.1.0)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
 
 PLATFORMS
   ruby
@@ -15,3 +28,4 @@ DEPENDENCIES
   bundler (~> 1.3)
   katip!
   rake
+  rspec (~> 3.0.0)

data/MIT-LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 lab2023 - internet technologies
+Copyright (c) 2014 lab2023 - information technologies
 
 MIT License
 

data/README.md

@@ -44,6 +44,15 @@ If you want to name your log file other than CHANGELOG.md
   Create MyCustomFile.md
 ```
 
+Also you can easily specify tag ranges:
+
+```sh
+  % katip --from=0.2.0 --to=0.9.1
+  # Or
+  % katip --from=0.2.0
+  # Or
+  % katip --to=0.9.1
+```
 
 ### Using as a rake
 Add gem in your Gemfile:
@@ -115,10 +124,12 @@ Once you've made your great commits:
 
 ## Credits
 
-- Katip is maintained and funded by [lab2023 - internet technologies](http://lab2023.com/)
+![lab2023](http://lab2023.com/assets/images/named-logo.png)
+
+- Katip is maintained and funded by [lab2023 - information technologies](http://lab2023.com/)
 - Thank you to all the [contributors!](https://github.com/kebab-project/katip/graphs/contributors)
 - The names and logos for lab2023 are trademarks of lab2023, inc.
 
 ## License
 
-Copyright 2012 lab2023 – internet technologies
+Copyright 2014 lab2023 - information technologies

data/bin/katip

@@ -1,14 +1,32 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
 
 require 'katip'
 require 'katip/change_logger'
+require 'optparse'
+
+options = { :from => nil, :to => nil }
+
+parser = OptionParser.new do |opts|
+  opts.on '-f', '--from from', 'From' do |from|
+    options[:from] = from
+  end
+
+  opts.on '-t', '--to to', 'To' do |to|
+    options[:to] = to
+  end
+end
+
+parser.parse! ARGV
+
+options[:from] = options[:from].nil? ? nil : options[:from].to_s
+options[:to] = options[:to].nil? ? nil : options[:to].to_s
 
 if ARGV.size > 0
-  change_logger = Katip::ChangeLogger.new(ARGV.first)
+  change_logger = Katip::ChangeLogger.new(ARGV.first, options[:from], options[:to])
 else
-  change_logger = Katip::ChangeLogger.new()
+  change_logger = Katip::ChangeLogger.new('CHANGELOG.md', options[:from], options[:to])
 end
 
 change_logger.log_changes

data/katip.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
 
   spec.extra_rdoc_files = %w[README.md CHANGELOG.md]
 end

data/lib/katip/change_logger.rb

@@ -9,17 +9,21 @@ module Katip
     # initialize
     #
     # @param [String] file_name with path
-    def initialize(file_name='CHANGELOG.md')
+    def initialize(file_name='CHANGELOG.md', from=nil, to=nil)
       @file_name = file_name
+      @tag_from = from
+      @tag_to = to
     end
 
     def log_changes
       if git_repository?
-        write_file parse_change_log
+        output = parse_change_log
+        write_file output unless output.empty?
       end
     end
 
     private
+
     def git_repository?
       initialized = `git rev-parse --is-inside-work-tree`.chomp
 
@@ -45,16 +49,34 @@ module Katip
     end
 
     def parse_change_log
-
       output = []
 
-      tags=`git for-each-ref --sort='*authordate' --format='%(tag)' refs/tags | grep -v '^$'`
+      tags = `git for-each-ref --sort='*authordate' --format='%(tag)' refs/tags | grep -v '^$'#`
 
       tags = tags.split
+      prev_begin = nil
+
+      if (!@tag_from.nil? && !tags.include?(@tag_from)) || (!@tag_to.nil? && !tags.include?(@tag_to))
+        show_not_found_message(tags)
+        return output
+      end
+
+      if !@tag_from.nil? && !@tag_to.nil?
+        from = tags.index(@tag_from)
+        to = tags.index(@tag_to)
+        tags = tags[from..to]
+      elsif !@tag_from.nil?
+        from = tags.index @tag_from
+        prev_begin = tags[from - 1]
+        tags = tags[from..-1]
+      elsif !@tag_to.nil?
+        to = tags.index @tag_to
+        tags = tags[0..to]
+      end
 
       tags.reverse!
 
-      output << "\n#### [Current]"
+      output << "\n#### [Current]" if @tag_to.nil?
 
       previous_tag=''
       tags.each do |tag|
@@ -64,14 +86,22 @@ module Katip
           output << "\n#### #{previous_tag}"
         end
 
-        output << `git log --pretty=format:" * [%h](#{COMMIT_URL}%h) - __(%an)__ %s%n%n%-b" "#{current_tag}".."#{previous_tag}" | grep -v "Merge branch "`
+        if !previous_tag.empty? || @tag_to.nil?
+          output << `git log --pretty=format:" * [%h](#{COMMIT_URL}%h) - __(%an)__ %s%n%n%-b" "#{current_tag}".."#{previous_tag}" | grep -v "Merge branch "`
+        end
 
         previous_tag = current_tag
       end
 
       output << "\n#### #{previous_tag}"
 
-      output << `git log --pretty=format:" * [%h](#{COMMIT_URL}%h) - __(%an)__ %s%n%n%-b" #{previous_tag} | grep -v "Merge branch "`
+      if prev_begin.nil?
+        output << `git log --pretty=format:" * [%h](#{COMMIT_URL}%h) - __(%an)__ %s%n%n%-b" #{previous_tag} | grep -v "Merge branch "`
+      else
+        output << `git log --pretty=format:" * [%h](#{COMMIT_URL}%h) - __(%an)__ %s%n%n%-b" "#{prev_begin}".."#{previous_tag}" | grep -v "Merge branch "`
+      end
+
+
 
       output.each do |line|
         line.encode!('utf-8', 'utf-8', invalid: :replace, undef: :replace, replace: '')
@@ -83,5 +113,11 @@ module Katip
 
       output
     end
+
+    def show_not_found_message(tags)
+      puts 'Could not find the given tags. Make sure that given tags exist.'
+      puts 'Listing found tags:'
+      puts tags
+    end
   end
 end

data/lib/katip/version.rb

@@ -1,3 +1,3 @@
 module Katip
-  VERSION = '1.4.1'
+  VERSION = '1.5.1'
 end

data/spec/basics_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'digest'
+
+repo = File.join(File.dirname(__FILE__), 'katip-sample-repo')
+
+describe 'Katip application' do
+  before do
+    Dir.chdir repo
+  end
+
+  it 'creates the change log with default name' do
+    change_logger = Katip::ChangeLogger.new
+    change_logger.log_changes
+    expect(File.exists?('CHANGELOG.md')).to be true
+  end
+
+  it 'creates the change log with given name' do
+    change_logger = Katip::ChangeLogger.new 'SampleChangeLog.md'
+    change_logger.log_changes
+    expect(File.exists?('SampleChangeLog.md')).to be true
+  end
+
+  it 'creates the change log files properly' do
+    change_logger = Katip::ChangeLogger.new
+    change_logger.log_changes
+
+    original_file = Digest::MD5.file('../results/CHANGELOG.md').to_s
+    result_file = Digest::MD5.file('CHANGELOG.md').to_s
+
+    expect(result_file).to eq original_file
+  end
+
+  it 'creates the change log files properly with different name' do
+    change_logger = Katip::ChangeLogger.new 'MyChangelog.md'
+    change_logger.log_changes
+
+    original_file = Digest::MD5.file('../results/MyChangelog.md').to_s
+    result_file = Digest::MD5.file('MyChangelog.md').to_s
+
+    expect(result_file).to eq original_file
+  end
+
+
+  after do
+    FileUtils.rm 'CHANGELOG.md' if File.exists? File.join(repo, 'CHANGELOG.md')
+    FileUtils.rm 'SampleChangeLog.md' if File.exists? File.join(repo, 'SampleChangeLog.md')
+    FileUtils.rm 'MyChangelog.md' if File.exists? File.join(repo, 'MyChangelog.md')
+  end
+end

data/spec/results/BeginChangeLog.md

@@ -0,0 +1,19 @@
+
+#### [Current]
+
+
+#### 0.5.0
+ * [a931c96](../../commit/a931c96) - __(Ahmet Sezgin Duran)__ Bump version 0.5.0
+ * [221be7f](../../commit/221be7f) - __(Ahmet Sezgin Duran)__ Update README
+
+#### 0.4.0
+ * [8bb14e8](../../commit/8bb14e8) - __(Ahmet Sezgin Duran)__ Bump version 0.4.0
+ * [c7671b1](../../commit/c7671b1) - __(Ahmet Sezgin Duran)__ Update README
+
+#### 0.3.0
+ * [62a3898](../../commit/62a3898) - __(Ahmet Sezgin Duran)__ Bump version 0.3.0
+ * [6bc7639](../../commit/6bc7639) - __(Ahmet Sezgin Duran)__ Update README
+
+#### 0.2.0
+ * [c6936a1](../../commit/c6936a1) - __(Ahmet Sezgin Duran)__ Bump version 0.2.0
+ * [7f3e312](../../commit/7f3e312) - __(Ahmet Sezgin Duran)__ Update README.md

data/spec/results/CHANGELOG.md

@@ -0,0 +1,24 @@
+
+#### [Current]
+
+
+#### 0.5.0
+ * [a931c96](../../commit/a931c96) - __(Ahmet Sezgin Duran)__ Bump version 0.5.0
+ * [221be7f](../../commit/221be7f) - __(Ahmet Sezgin Duran)__ Update README
+
+#### 0.4.0
+ * [8bb14e8](../../commit/8bb14e8) - __(Ahmet Sezgin Duran)__ Bump version 0.4.0
+ * [c7671b1](../../commit/c7671b1) - __(Ahmet Sezgin Duran)__ Update README
+
+#### 0.3.0
+ * [62a3898](../../commit/62a3898) - __(Ahmet Sezgin Duran)__ Bump version 0.3.0
+ * [6bc7639](../../commit/6bc7639) - __(Ahmet Sezgin Duran)__ Update README
+
+#### 0.2.0
+ * [c6936a1](../../commit/c6936a1) - __(Ahmet Sezgin Duran)__ Bump version 0.2.0
+ * [7f3e312](../../commit/7f3e312) - __(Ahmet Sezgin Duran)__ Update README.md
+
+#### 0.1.0
+ * [0597893](../../commit/0597893) - __(Ahmet Sezgin Duran)__ Bump version 0.1.0
+ * [b57e295](../../commit/b57e295) - __(Ahmet Sezgin Duran)__ Update README.md
+ * [cfc3aa4](../../commit/cfc3aa4) - __(Onur Özgür ÖZKAN)__ Initial commit

data/spec/results/MyChangelog.md

@@ -0,0 +1,24 @@
+
+#### [Current]
+
+
+#### 0.5.0
+ * [a931c96](../../commit/a931c96) - __(Ahmet Sezgin Duran)__ Bump version 0.5.0
+ * [221be7f](../../commit/221be7f) - __(Ahmet Sezgin Duran)__ Update README
+
+#### 0.4.0
+ * [8bb14e8](../../commit/8bb14e8) - __(Ahmet Sezgin Duran)__ Bump version 0.4.0
+ * [c7671b1](../../commit/c7671b1) - __(Ahmet Sezgin Duran)__ Update README
+
+#### 0.3.0
+ * [62a3898](../../commit/62a3898) - __(Ahmet Sezgin Duran)__ Bump version 0.3.0
+ * [6bc7639](../../commit/6bc7639) - __(Ahmet Sezgin Duran)__ Update README
+
+#### 0.2.0
+ * [c6936a1](../../commit/c6936a1) - __(Ahmet Sezgin Duran)__ Bump version 0.2.0
+ * [7f3e312](../../commit/7f3e312) - __(Ahmet Sezgin Duran)__ Update README.md
+
+#### 0.1.0
+ * [0597893](../../commit/0597893) - __(Ahmet Sezgin Duran)__ Bump version 0.1.0
+ * [b57e295](../../commit/b57e295) - __(Ahmet Sezgin Duran)__ Update README.md
+ * [cfc3aa4](../../commit/cfc3aa4) - __(Onur Özgür ÖZKAN)__ Initial commit

data/spec/results/TagRangeLog.md

@@ -0,0 +1,17 @@
+
+#### 0.4.0
+ * [8bb14e8](../../commit/8bb14e8) - __(Ahmet Sezgin Duran)__ Bump version 0.4.0
+ * [c7671b1](../../commit/c7671b1) - __(Ahmet Sezgin Duran)__ Update README
+
+#### 0.3.0
+ * [62a3898](../../commit/62a3898) - __(Ahmet Sezgin Duran)__ Bump version 0.3.0
+ * [6bc7639](../../commit/6bc7639) - __(Ahmet Sezgin Duran)__ Update README
+
+#### 0.2.0
+ * [c6936a1](../../commit/c6936a1) - __(Ahmet Sezgin Duran)__ Bump version 0.2.0
+ * [7f3e312](../../commit/7f3e312) - __(Ahmet Sezgin Duran)__ Update README.md
+
+#### 0.1.0
+ * [0597893](../../commit/0597893) - __(Ahmet Sezgin Duran)__ Bump version 0.1.0
+ * [b57e295](../../commit/b57e295) - __(Ahmet Sezgin Duran)__ Update README.md
+ * [cfc3aa4](../../commit/cfc3aa4) - __(Onur Özgür ÖZKAN)__ Initial commit

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'katip'
+require 'rspec'
+
+RSpec.configure do |config|
+
+end

data/spec/tag_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+repo = File.join(File.dirname(__FILE__), 'katip-sample-repo')
+
+describe 'Tag system' do
+  before do
+    Dir.chdir repo
+  end
+
+  it 'creates the change log with the given tag range' do
+    change_logger = Katip::ChangeLogger.new 'CHANGELOG.md', '0.1.0', '0.4.0'
+    change_logger.log_changes
+
+    original_file = Digest::MD5.file('../results/TagRangeLog.md').to_s
+    result_file = Digest::MD5.file('CHANGELOG.md').to_s
+
+    expect(result_file).to eq original_file
+  end
+
+  it 'creates the change log with the given beginning tag' do
+    change_logger = Katip::ChangeLogger.new 'CHANGELOG.md', '0.2.0'
+    change_logger.log_changes
+
+    original_file = Digest::MD5.file('../results/BeginChangeLog.md').to_s
+    result_file = Digest::MD5.file('CHANGELOG.md').to_s
+
+    expect(result_file).to eq original_file
+  end
+
+  it 'creates the change log with the given ending tag' do
+    change_logger = Katip::ChangeLogger.new 'CHANGELOG.md', nil, '0.4.0'
+    change_logger.log_changes
+
+    original_file = Digest::MD5.file('../results/TagRangeLog.md').to_s
+    result_file = Digest::MD5.file('CHANGELOG.md').to_s
+
+    expect(result_file).to eq original_file
+  end
+
+  after do
+    FileUtils.rm 'CHANGELOG.md' if File.exists? File.join(repo, 'CHANGELOG.md')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katip
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.1
 platform: ruby
 authors:
 - lab2023
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: This is a Change Logging gem for a git initialized project.
 email:
 - info@lab2023.com
@@ -49,6 +63,8 @@ extra_rdoc_files:
 - CHANGELOG.md
 files:
 - ".gitignore"
+- ".gitmodules"
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -63,6 +79,13 @@ files:
 - lib/katip/railtie.rb
 - lib/katip/version.rb
 - lib/tasks/katip.rake
+- spec/basics_spec.rb
+- spec/results/BeginChangeLog.md
+- spec/results/CHANGELOG.md
+- spec/results/MyChangelog.md
+- spec/results/TagRangeLog.md
+- spec/spec_helper.rb
+- spec/tag_spec.rb
 homepage: https://github.com/kebab-project/katip
 licenses:
 - MIT
@@ -90,3 +113,4 @@ summary: Katip is a gem which dumps the change log as a list grouped by version
   It also has an executable ruby file katip, which can be used in any git project.
   Log rows will contain links to commits, commit note and contributor name.
 test_files: []
+has_rdoc: