katip 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b509ee7719357955f294253549faefd8fbecab36
-  data.tar.gz: 545696486d5e36617a756b23842fe527f12ac08c
+  metadata.gz: adf5bbf98c475d486485fa10d00f93b58d660e95
+  data.tar.gz: a4594d538636fd600314dec01ba7c37d27366282
 SHA512:
-  metadata.gz: 1e2e0384b0f8db3b13d9a44c56f4ddf066e45057cc779832efcd76c65ed7da5e5b57ad6eb8c4936acd4686f6a3ee0156e4e537cfb36560e527b862c165f8d412
-  data.tar.gz: 6341ea1ecff7baab2a252b0040ef7ff6ec787fa5d7bb7952f48060947c95fe2ccd8f309959eecc502780a782d1fdb2dbfb547239e0e18a6f3fb74bd601dade58
+  metadata.gz: 17c107230678e3bf30987cebeed1b5108e5ccd34f70a6e970be8e17b8d5710cda2645f848a9431218b3f4ad9ee6964a936daa13aa12841cfc06a075b8cdb9a9b
+  data.tar.gz: 78a56b738abb653b78b64e5cc93ffb7e0b193acd17394f73eac334b0d95df20fc14dc98116152925f0cc20e2ef72b63c259584862ea3702544994011c25e70d4

data/CHANGELOG.md

@@ -1,8 +1,12 @@
 
 #### [Current]
 
-#### []
- * [18fba8f](../../commit/18fba8f)  #3 Add logger file __(Murat Kemal BAYGÜN)__
- * [105af37](../../commit/105af37) Update readme __(Murat Kemal BAYGÜN)__
- * [bc56515](../../commit/bc56515) Initial commit __(Murat Kemal BAYGÜN)__
- * [1b1d477](../../commit/1b1d477) Initial commit __(Murat Kemal BAYGÜN)__
+#### 0.1.0
+ * [de3acfb](de3acfb) #6 Update gemspec __(Onur Ozgur OZKAN)__
+ * [498c3d6](498c3d6) #6 Set gem __(Onur Ozgur OZKAN)__
+ * [416e6c8](416e6c8) #6 Set gem __(Onur Ozgur OZKAN)__
+ * [c820767](c820767)  #4 Add CHANGELOG.md file __(Murat Kemal BAYGÜN)__
+ * [18fba8f](18fba8f)  #3 Add logger file __(Murat Kemal BAYGÜN)__
+ * [105af37](105af37) Update readme __(Murat Kemal BAYGÜN)__
+ * [bc56515](bc56515) Initial commit __(Murat Kemal BAYGÜN)__
+ * [1b1d477](1b1d477) Initial commit __(Murat Kemal BAYGÜN)__

data/README.md

@@ -3,7 +3,53 @@ Katip
 
 This is a Change Logging gem for a git initialized project.
 
-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.
+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.
+
+## Installation
+
+To install Katip just use:
+
+```sh
+gem install katip
+```
+
+When using bundler put it in your Gemfile:
+
+```ruby
+source 'https://rubygems.org'
+
+gem 'katip'
+```
+
+## Usage
+
+### Using the executable
+
+In your git initialized project directory simply run
+
+```sh
+  % daktilo
+  Create CHANGELOG.md
+```
+
+
+### Using as a rake
+Add gem in your Gemfile:
+
+```ruby
+source 'https://rubygems.org'
+
+gem 'katip'
+```
+
+```sh
+  % rake katip:create
+  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.
 
 #### Links to resources
 

data/bin/daktilo

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+DEFAULT_FILE='CHANGELOG.md'
+
+def write_file(output, file_name=DEFAULT_FILE)
+  begin
+    file = File.open(file_name, "w")
+    file.puts output
+
+    puts "Create #{file_name}"
+  rescue IOError => e
+    #some error occur, dir not writable etc.
+  ensure
+    file.close unless file == nil
+  end
+end
+
+def parse_change_log
+
+  output = []
+
+  tags=`git for-each-ref --sort='*authordate' --format='%(tag)' refs/tags | grep -v '^$'`
+
+  tags = tags.split
+
+  tags.reverse!
+
+  output << "\n#### [Current]"
+
+  previous_tag=nil
+  tags.each do |tag|
+    current_tag = tag
+
+    if previous_tag
+      output << "\n#### #{previous_tag}"
+
+      output << `git log --pretty=format:" * [%h]($repo_url%h) %s __(%an)__" "#{current_tag}".."#{previous_tag}" | grep -v "Merge branch "`
+    end
+
+    previous_tag = current_tag
+  end
+
+  output << "\n#### #{previous_tag}"
+  output << `git log --pretty=format:" * [%h]($repo_url%h) %s __(%an)__" #{previous_tag} | grep -v "Merge branch "`
+
+  output
+end
+
+write_file parse_change_log
+
+

data/katip.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
+  spec.executables   = %w[daktilo]
   spec.require_paths = %w[lib]
 
   spec.add_development_dependency 'bundler', '~> 1.3'

data/lib/katip/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katip
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - lab2023
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-18 00:00:00.000000000 Z
+date: 2013-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -41,7 +41,8 @@ dependencies:
 description: This is a Change Logging gem for a git initialized project.
 email:
 - info@lab2023.com
-executables: []
+executables:
+- daktilo
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -52,6 +53,7 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- bin/daktilo
 - katip.gemspec
 - lib/katip.rb
 - lib/katip/railtie.rb
@@ -84,3 +86,4 @@ summary: Planned to design a rake which dumps the change log as a list grouped b
   version tags. Log rows will contain links to commits, commit note and contributer
   name.
 test_files: []
+has_rdoc: