katip 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adf5bbf98c475d486485fa10d00f93b58d660e95
-  data.tar.gz: a4594d538636fd600314dec01ba7c37d27366282
+  metadata.gz: 719d74b2fe50e71ab786572062f853fee6a82910
+  data.tar.gz: 00f669ba1fc6dac46f33711f78f2eddc5f1b8f5f
 SHA512:
-  metadata.gz: 17c107230678e3bf30987cebeed1b5108e5ccd34f70a6e970be8e17b8d5710cda2645f848a9431218b3f4ad9ee6964a936daa13aa12841cfc06a075b8cdb9a9b
-  data.tar.gz: 78a56b738abb653b78b64e5cc93ffb7e0b193acd17394f73eac334b0d95df20fc14dc98116152925f0cc20e2ef72b63c259584862ea3702544994011c25e70d4
+  metadata.gz: 4f3d423b057a5f458d16a653a8ffc817140042de1ae4b5fe37308e9c29f79a680f4b968210203b90afe815c51751514de96863e6aaf7f46d9a1dce95038fa9ba
+  data.tar.gz: ee87a0e765bd945a5b9318c727e6e5d85a2dd92691893cdb8f2f396918650e8af03a4caac5a26e3d67f8a401c416185efc24785f54ba41c0bde56b14a6b491d6

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 
 #### [Current]
+ * [6b8cfe7](6b8cfe7) #13 Add custom file name support to rake __(Murat Kemal BAYGÜN)__
+ * [7b5be3d](7b5be3d) #10 add output file name as optional parameter __(Murat Kemal BAYGÜN)__
+ * [695646c](695646c) #12 Add and correct information on gemspec __(Murat Kemal BAYGÜN)__
+ * [f30a3b2](f30a3b2) #9 Update rake job to use installed executable __(Murat Kemal BAYGÜN)__
+ * [a7200f0](a7200f0) #11 Fix bug Current commits is not seen on log file __(Murat Kemal BAYGÜN)__
+ * [6385fff](6385fff) #8 Change executable file name to katip __(Murat Kemal BAYGÜN)__
+
+#### 0.2.0
+ * [61b2f06](61b2f06) Version 0.2.0 __(Murat Kemal BAYGÜN)__
+ * [9bd7659](9bd7659) #7 Fix documentation __(Murat Kemal BAYGÜN)__
+ * [2abca18](2abca18) #7 Organize readme, add usage for daktilo __(Murat Kemal BAYGÜN)__
+ * [b939475](b939475) #7 Add output message to inform user __(Murat Kemal BAYGÜN)__
+ * [99d3b3f](99d3b3f) #7 Add executable ruby file to gem to generate default output CHANGELOG.md __(Murat Kemal BAYGÜN)__
+ * [7265622](7265622)  #4 Add simple usage documentation on readme __(Murat Kemal BAYGÜN)__
 
 #### 0.1.0
  * [de3acfb](de3acfb) #6 Update gemspec __(Onur Ozgur OZKAN)__

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    katip (0.1.0)
+    katip (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -4,8 +4,8 @@ Katip
 This is a Change Logging gem for a git initialized project.
 
 Katip is a gem which dumps the change log as a list grouped by version tags.
-It also has an executable ruby file **daktilo**, which can be used in any git project.
-Log rows will contain links to commits, commit note and contributer name.
+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.
 
 ## Installation
 
@@ -30,10 +30,17 @@ gem 'katip'
 In your git initialized project directory simply run
 
 ```sh
-  % daktilo
+  % katip
   Create CHANGELOG.md
 ```
 
+If you want to name your log file other than CHANGELOG.md
+
+```sh
+  % katip MyCustomFile.md
+  Create MyCustomFile.md
+```
+
 
 ### Using as a rake
 Add gem in your Gemfile:
@@ -49,7 +56,14 @@ gem 'katip'
   Create CHANGELOG.md
 ```
 
-and that's it. You have a CHANGELOG.md file on project root, generated based on your git commits and created release tags.
+If you want to name your log file other than CHANGELOG.md
+
+```sh
+  % rake katip:create file=MyCustomFile.md
+  Create MyCustomFile.md
+```
+
+and that's it. You have your change log file on project root, generated based on your git commits and created release tags.
 
 #### Links to resources
 

data/bin/{daktilo → katip}

@@ -1,10 +1,15 @@
 #!/usr/bin/env ruby
 
-DEFAULT_FILE='CHANGELOG.md'
+def write_file(output)
+
+  file_name='CHANGELOG.md'
+
+  if ARGV.length > 0
+    file_name=ARGV[0]
+  end
 
-def write_file(output, file_name=DEFAULT_FILE)
   begin
-    file = File.open(file_name, "w")
+    file = File.open(file_name, 'w')
     file.puts output
 
     puts "Create #{file_name}"
@@ -27,16 +32,16 @@ def parse_change_log
 
   output << "\n#### [Current]"
 
-  previous_tag=nil
+  previous_tag=''
   tags.each do |tag|
     current_tag = tag
 
-    if previous_tag
+    unless previous_tag.empty?
       output << "\n#### #{previous_tag}"
-
-      output << `git log --pretty=format:" * [%h]($repo_url%h) %s __(%an)__" "#{current_tag}".."#{previous_tag}" | grep -v "Merge branch "`
     end
 
+    output << `git log --pretty=format:" * [%h]($repo_url%h) %s __(%an)__" "#{current_tag}".."#{previous_tag}" | grep -v "Merge branch "`
+
     previous_tag = current_tag
   end
 

data/katip.gemspec

@@ -9,12 +9,12 @@ Gem::Specification.new do |spec|
   spec.authors       = %w[lab2023]
   spec.email         = %w[info@lab2023.com]
   spec.description   = %q{This is a Change Logging gem for a git initialized project.}
-  spec.summary       = %q{Planned to design a rake which dumps the change log as a list grouped by version tags. Log rows will contain links to commits, commit note and contributer name.}
+  spec.summary       = %q{Katip is a gem which dumps the change log as a list grouped by version tags. 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.}
   spec.homepage      = 'https://github.com/kebab-project/katip'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = %w[daktilo]
+  spec.executables   = %w[katip]
   spec.require_paths = %w[lib]
 
   spec.add_development_dependency 'bundler', '~> 1.3'

data/lib/katip.rb

@@ -3,49 +3,18 @@ require 'katip/version'
 module Katip
   require 'katip/railtie' if defined?(Rails)
 
-  @@daktilo = <<-SHELL
-# Get tags as an array
-TAGS_ARRAY=(`git for-each-ref --sort='*authordate' --format='%(tag)' refs/tags | grep -v '^$'`)
-
-repo_url="../../commit/"
-
-# Set User defined file if exist else use default
-if [ -n "$1" ]; then
-  OUTPUT=$1
-else
-  OUTPUT="CHANGELOG.md"
-fi
-
-# Calculate the tag count
-SIZE=${#TAGS_ARRAY[@]}
-
-echo "\n#### [Current]" > $OUTPUT
-
-# Iterate reversly on tags
-for (( i = SIZE - 1; i >= 0 ; i-- ));
-do
-  CURR_TAG=${TAGS_ARRAY[$i]}
-    echo "" >> $OUTPUT
-    if [ $PREV_TAG ];then
-        echo "#### [$PREV_TAG]" >> $OUTPUT
-    fi
-    git log --pretty=format:" * [%h]($repo_url%h) %s __(%an)__" $CURR_TAG..$PREV_TAG | grep -v "Merge branch " >> $OUTPUT
-    PREV_TAG=$CURR_TAG
-done
-
-# Dump change log for first tag
-FIRST=$(git tag -l | head -1)
-echo "\n#### [$FIRST]" >> $OUTPUT
-
-git log --pretty=format:" * [%h]($repo_url%h) %s __(%an)__" $FIRST | grep -v "Merge branch " >> $OUTPUT
-  SHELL
+  @@katip = `katip`
 
   def self.set(param)
-    @@daktilo = param
+    @@katip = param
   end
 
   def self.get
-    @@daktilo
+    @@katip
+  end
+
+  def self.get_file(file_name)
+    @@katip = "katip #{file_name}"
   end
 
 end

data/lib/katip/version.rb

@@ -1,3 +1,3 @@
 module Katip
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

data/lib/tasks/katip.rake

@@ -1,7 +1,10 @@
 namespace :katip do
   desc 'Create CHANGELOG.md'
   task :create => [:environment] do
-    puts 'Create CHANGELOG.md'
-    exec Katip.get
+
+    file_name = ENV['file'] || 'CHANGELOG.md'
+
+    exec Katip.get_file(file_name)
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katip
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - lab2023
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,7 +42,7 @@ description: This is a Change Logging gem for a git initialized project.
 email:
 - info@lab2023.com
 executables:
-- daktilo
+- katip
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -53,7 +53,7 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
-- bin/daktilo
+- bin/katip
 - katip.gemspec
 - lib/katip.rb
 - lib/katip/railtie.rb
@@ -82,8 +82,7 @@ rubyforge_project:
 rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
-summary: Planned to design a rake which dumps the change log as a list grouped by
-  version tags. Log rows will contain links to commits, commit note and contributer
-  name.
+summary: Katip is a gem which dumps the change log as a list grouped by version tags.
+  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: