crackin 0.1.0 → 0.1.1.alpha0

data/.crackin.yml

@@ -1,13 +1,14 @@
 ---
 crackin:
   name: crackin
+  debug: true
   scm: git
   changelog: CHANGELOG.md
   branch:
     production: master
     development: develop
   status:
-    verbose: true
+    verbose: false
   version: lib/crackin/version.rb
   build:
     command: rake build

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ### Changelog
 
+##### v0.1.1.alpha0:
+* disable verbose status
+* better debug handling for git
+* add debug option. setup logging for Git if debug true
+* add pull method
+* do source.pull to make sure things are up to date
+* add some basic documentation
+
 ##### v0.1.0:
 * add 'add' method to scm api
 * add some more inforation to initialization. fix bug with name of method in scm: git. make sure *all* files are added before commit during a crackin release finish.

data/README.md

@@ -1,6 +1,23 @@
 # Crackin
 
-TODO: Write a gem description
+Simple, generalized way to handle gem releases.
+
+Much of this code has been developing over time 
+in a bunch of my projects. I decided to pull it 
+all together into one place.
+
+## Philosophy
+
+* Use semantic versioning, as much as possible. http://semver.org
+  * doesn't currently support build numbers or architectures.
+* Support MAJOR _1_.0.0 releases
+* Support MINOR 0._1_.0 releases
+* Support TINY 0.0._1_ releases
+* Support TAG (pre) releases
+  * release candidate: 0.1.0._rc1_
+  * beta: 0.1.0._beta1_
+  * alpha: 0.1.0._alpha1_
+* Manage the release process similar to git flow.
 
 ## Installation
 
@@ -18,7 +35,101 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Once `Crackin` has been added to your bundle or installed, you can do the following:
+
+`crackin init`
+
+This will create a `.crackin.yml` file and a `CHANGELOG.md` file (if it doesn't already exist).
+The command's output will prompt with you further inforamtion.
+
+## Status
+
+Use the `crackin status` command to get more information. The general idea is:
+
+1. work on code in your development branch (default: 'develop')
+   or work on code in feature branches and merge to development branch
+2. once everything is merged to development and pushed, you can start a release.
+
+3. `crackin release <type>`
+   * create a temporary release branch from master
+   * merge from develop
+   * update version file
+   * update changelog file
+   * allow you to make any final updates (this is normally for customizing the changelog)
+4. Once you're finished with changes (you don't need to commit them).
+5. `crackin release finish`
+   * add and commit changes to release branch
+   * merge release branch to master
+   * create a tag
+   * run a gem build (currently uses bundler gem task)
+   * push master
+   * push tags
+   * push gem
+   * merge master to develop
+   * delete release branch (this should be configurable)
+   * push develop (not working currently)
+
+## Files
+
+### Configuration file
+
+An example of the configuration file. _Subject to change_
+
+```
+---
+crackin:
+  name: crackin
+  version: lib/crackin/version.rb
+  scm: git
+  changelog: CHANGELOG.md
+  branch:
+    production: master
+    development: develop
+  status:
+    verbose: true
+  build:
+    command: rake build
+    after: []
+```
+
+Pay special attention to `name` and `version`, these values must be set after initialization.
+
+### Version file
+
+The format that `Crackin` expects for the version.rb file of your gem.
+
+```
+module Crackin
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    TINY = 0
+    TAG = nil
+    LIST = [MAJOR, MINOR, TINY, TAG]
+    STRING = LIST.compact.join(".")
+  end
+end
+```
+
+It uses this format to manipulate the values during releases.
+
+### Changelog file
+
+The format of the changelog file.
+
+```
+### Changelog
+
+##### v0.1.0:
+* add 'add' method to scm api
+* add some more inforation to initialization. fix bug with name of method in scm: git. make sure *all* files are added before commit during a crackin release finish.
+
+##### v0.0.1.rc0:
+* initial
+```
+
+Currently, `Crackin` just includes all commit *subjects* for each tag. It does this by walking the tags
+and getting the commits between them.
 
 ## Contributing
 

data/lib/crackin/ext/core/hash.rb

@@ -10,4 +10,8 @@ class Hash
   def deep_stringify_keys
     deep_transform_keys{ |key| key.to_s }
   end unless Hash.respond_to?(:deep_stringify_keys)
+
+  def deep_symbolize_keys
+    deep_transform_keys{ |key| key.to_sym }
+  end unless Hash.respond_to?(:deep_symbolize_keys)
 end

data/lib/crackin/release.rb

@@ -65,6 +65,13 @@ module Crackin
 
     def start_actions
       actions = []
+      # update current branch
+      actions << {
+          name: "update branch",
+          do: -> { @source.pull },
+          undo: -> { @source.change_branch(@config['branch']['development']) },
+          if: @current == @config['branch']['development']
+      }
       # change branch
       actions << {
           name: "change to production branch",

data/lib/crackin/scm/git.rb

@@ -8,7 +8,9 @@ module Crackin
       def initialize(config={})
         super
         #@git = ::Git.open(@options[:working], log: Logger.new(STDOUT))
-        @git = ::Git.open(@options[:working])
+        o = {}
+        o['log'] = Logger.new(STDOUT) if config['debug']
+        @git = ::Git.open(@options[:working], o.deep_symbolize_keys)
       end
 
       def add(options={})
@@ -67,6 +69,10 @@ module Crackin
         @git.branch(Shellwords.escape(name)).delete
       end
 
+      def pull
+        @git.pull
+      end
+
       def push
         @git.push
       end

data/lib/crackin/version.rb

@@ -2,8 +2,8 @@ module Crackin
   module Version
     MAJOR = 0
     MINOR = 1
-    TINY = 0
-    TAG = nil
+    TINY = 1
+    TAG = 'alpha0'
     LIST = [MAJOR, MINOR, TINY, TAG]
     STRING = LIST.compact.join(".")
   end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: crackin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1.alpha0
+  prerelease: 6
 platform: ruby
 authors:
 - Shawn Catanzarite
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-22 00:00:00.000000000 Z
+date: 2014-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -76,6 +86,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -113,25 +124,29 @@ files:
 homepage: http://github.com/shawncatz/crackin
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3441222254428678362
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: release the crackin - gem release management
 test_files: []

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YzQ0ZGVlMjc1NjM2YzI0ZDdkMWNjNGMwNTdjMDg3ZjRjYjI0Y2Q1Yg==
-  data.tar.gz: !binary |-
-    YjZmYWNjNDExNGNlODYzODhkZTFmNTE2M2JiMjFlYzYyNDc1YzBhOA==
-SHA512:
-  metadata.gz: !binary |-
-    ZmM1MjBmMmEyMTdjNjNiZDE1YzE3NjA2ZTU2YzE2M2M5YzQ1OWU4NWYxZjkz
-    Y2FlMmI3N2YwNjNmZWViYmZlNGRiMjEzNjYzOTEyMmY2ZTI1ZTU0MWNmOWYy
-    ZjgwNTYyOTlhNGE3MWY5YTExMjE5ZDAyZjA0ZDhlMmJiMTBhNjA=
-  data.tar.gz: !binary |-
-    OWI0ZTg1NDFjNWFmY2E5YmNhNjcxOTlmOWY1MjZhYjU4ZjQzNjZiZTFmZDcy
-    M2QzM2RiNjhkYmZmY2E1YWVhOGJhMjNmNTM0OTM1ZmYyMTBiNDRmM2QzOTll
-    MWQ3ZGM1NjExYmU3YzJiYWFmYjhmNGY5MmE3MDNhODJlMmQ0ZjQ=