chchchanges 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02e6a1cfe609c3ca5b4ee80e93aaee9f88e466a2
+  data.tar.gz: ceb6cbc827e904f7600c03b134b3037688afdf1e
+SHA512:
+  metadata.gz: 6307ec5cc81dfa4e195693e8b35aef7222614a61f4309ca8badbf499bfa107a1d629bb4ba56ce27e05027fadadbbf741b07488c525b89810840f38929d089fcf
+  data.tar.gz: 042d90017b3b30d6ee013c859914c2f7e5968e07064db5eaf52637d0f71d85dd0270d9ac50a40657214c5fc835efc1cb16cbb14ffd5848ee643aebe5ed296734

data/.changelog_entries/1192b2e6cfb3c57360e4a90adb105f24.json

@@ -0,0 +1 @@
+{"type":"Fixed","ticket":"","url":"","description":"Fixed the CHANGELOG generator feature from writing the changelog to 9CHANGELOG","version":"0.1.0","tags":[]}

data/.changelog_entries/66dcb740d4c86e3ba889d7831baf7d30.json

@@ -0,0 +1 @@
+{"type":"Added","ticket":"","url":"","description":"Initial functionality with CHANGELOG entry, generator, and parser features","version":"0.1.0","tags":[]}

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.13.6

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+
+## [0.1.0]
+### Added
+- [] Initial functionality with CHANGELOG entry, generator, and parser features
+### Fixed
+- [] Fixed the CHANGELOG generator feature from writing the changelog to 9CHANGELOG

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ezell@rbmtechnologies.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chchchanges.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Eric Zell
+
+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,41 @@
+# Chchchanges
+
+### chchchanges makes it convenient to create and maintain a proper CHANGELOG.
+
+With chchchanges, users can create CHANGELOG entries from the command line. Each
+entry is saved as in individual .json file which prevents CHANGELOG merge conflicts.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chchchanges'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chchchanges
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/chchchanges. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chchchanges"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chchchanges.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chchchanges/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chchchanges"
+  spec.version       = Chchchanges::VERSION
+  spec.authors       = ["Eric Zell"]
+  spec.email         = ["ericjzell@gmail.com"]
+
+  spec.summary       = %q{chchchanges makes it convenient to create and maintain a proper CHANGELOG.}
+  spec.description   = %q{chchchanges makes it convenient to create and maintain a proper CHANGELOG.
+                          Users can create CHANGELOG entries from the command line. Each entry is saved
+                          as in individual .json file which prevents CHANGELOG merge conflicts.}
+  spec.homepage      = "https://github.com/EricJZell/chchchanges"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/exe/chchchanges

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'chchchanges'
+require 'optparse'
+
+options = {}
+
+option_parser = OptionParser.new do |opts|
+  executable_name = File.basename($PROGRAM_NAME)
+  opts.banner = "
+    Chchchanges makes it convenient to create and maintain a proper CHANGELOG.
+
+    Usage: chchchanges [options]
+  "
+
+  opts.on('-e', '--entry', 'Create a CHANGELOG entry') do
+    options[:entry] = true
+  end
+
+  opts.on('-g', '--generator', 'Generate a CHANGELOG from existing entries') do
+    options[:generator] = true
+  end
+
+  opts.on('-p', '--parser', 'Parse an existing CHANGELOG into individual .json files') do
+    options[:parser] = true
+  end
+
+end
+
+begin
+  option_parser.parse!
+  rescue OptionParser::InvalidOption => error
+  puts "Spydecz doesn't recognize that #{ error }"
+  exit
+  rescue OptionParser::AmbiguousOption => error
+  puts "That's an #{ error}"
+  exit
+end
+
+if options.empty?
+  puts "    error: you must enter a --entry, --generator, or --paser option"
+  puts option_parser.help
+else
+  Chchchanges::Entry.new.call if options[:entry]
+  Chchchanges::Generator.new.call if options[:generator]
+  Chchchanges::Parser.new.call if options[:parser]
+end

data/lib/chchchanges.rb

@@ -0,0 +1,8 @@
+require "chchchanges/version"
+require "chchchanges/entry"
+require "chchchanges/generator"
+require "chchchanges/parser"
+
+module Chchchanges
+  # Your code goes here...
+end

data/lib/chchchanges/entry.rb

@@ -0,0 +1,91 @@
+require 'json'
+require 'securerandom'
+module Chchchanges
+  class Entry
+
+    def initialize
+    end
+
+    def call
+      Dir.mkdir('.changelog_entries') unless Dir.exists?('.changelog_entries')
+      write_to_file
+    end
+
+    private
+
+    def get_version
+      puts "What is the targeted release version for this change? (example '15.5.11')"
+      user_input = gets.chomp
+      if user_input.match(/^(\d+\.)+\d+$/)
+        return user_input
+      else
+        handle_unexpected_input(user_input, "Invalid version number")
+        get_version
+      end
+    end
+
+    def get_type
+      change_types_hash = {
+        1 => "Added", 2 => "Changed", 3 => "Fixed", 4 => "Deprecated",
+        5 => "Removed", 6 => "Security", 7 => "Unspecified"
+      }
+      puts "What type of change is this?\n"
+      change_types_hash.each do |number, change_type|
+        puts "#{number} - #{change_type}\n"
+      end
+      user_input = gets.chomp
+      if change_types_hash.keys.include?(user_input.to_i)
+        return change_types_hash[user_input.to_i]
+      else
+        handle_unexpected_input(user_input, "Invalid change type selection")
+        get_type
+      end
+    end
+
+    def get_tags
+      puts "Please enter any tags, comma separated. (Optional)"
+      tags = gets.chomp.split(',')
+      tags.map! { |tag| tag.strip}
+    end
+
+    def get_ticket
+      puts "Please enter Ticket # (Optional):"
+      ticket = gets.chomp
+    end
+
+    def get_description
+      puts "Please enter a description for this change (at least 5 characters):"
+      description = gets.chomp
+      if description.match(/^.{5}/)
+        return description
+      else
+        handle_unexpected_input(description, "Invalid Description")
+        get_description
+      end
+    end
+
+    def handle_unexpected_input(input, message)
+      if input.downcase == 'q'
+        puts "Goodbye!"
+        exit
+      else
+        puts message
+      end
+    end
+
+    def write_to_file
+      version = get_version
+      info = {
+        type: get_type,
+        ticket: get_ticket,
+        url: "",
+        description: get_description,
+        version: version,
+        tags: get_tags
+      }.to_json
+      File.write(".changelog_entries/#{Time.now.strftime("%Y_%m_%d_%H%M")}_v#{version}.json", info)
+    end
+
+  end
+
+end

data/lib/chchchanges/generator.rb

@@ -0,0 +1,48 @@
+require 'json'
+module Chchchanges
+  class Generator
+    attr_accessor :changelog_hash, :changelog
+
+    def initialize
+      @changelog_hash = {}
+      @changelog = "# Change Log\n"
+    end
+
+    def call
+      read_changelog_entry_files
+      write_to_changelog_file
+    end
+
+    private
+
+    def read_changelog_entry_files
+      Dir.foreach('.changelog_entries') do |json_file|
+        next if json_file == '.' or json_file == '..'
+        entry = File.read(".changelog_entries/#{json_file}")
+        entry_hash = JSON.parse(entry)
+        version = entry_hash["version"]
+        type = entry_hash["type"]
+        description = entry_hash["description"]
+        ticket = entry_hash["ticket"]
+        @changelog_hash[version] = {} unless changelog_hash[version]
+        @changelog_hash[version][type] = [] unless changelog_hash[version][type]
+        @changelog_hash[version][type] << "- [#{ticket}] #{description}\n"
+      end
+    end
+
+    def write_to_changelog_file
+      versions = @changelog_hash.keys.sort_by{|v| Gem::Version.new(v)}.reverse
+      versions.each do |version|
+        change_types = changelog_hash[version]
+        @changelog << "\n## [#{version}]\n"
+        change_types.sort.each do |type, changes|
+          @changelog << "### #{type}\n"
+          changes.sort.each do |change|
+            @changelog << change
+          end
+        end
+      end
+      File.write('CHANGELOG.md', @changelog)
+    end
+  end
+end

data/lib/chchchanges/parser.rb

@@ -0,0 +1,78 @@
+require 'json'
+require 'securerandom'
+module Chchchanges
+  class Parser
+    attr_accessor :entries, :version, :type
+
+    def initialize
+      @entries = []
+      @version = ""
+      @type = ""
+    end
+
+    def call
+      Dir.mkdir('.changelog_entries') unless Dir.exists?('.changelog_entries')
+      parse_changelog
+      write_to_files
+    end
+
+    private
+
+    def get_version(line)
+      line.match(/\[(.*?)\]/)[1]
+    end
+
+    def get_type(line)
+      line.gsub('### ', '')
+    end
+
+    def get_description(line)
+      match = line.match(/^.*[\]\-] /)[0]
+      line.gsub(match, '')
+    end
+
+    def get_ticket(line)
+      match = line.match(/\[(.*?)\]/)
+      match ? match[1] : ""
+    end
+
+    def create_entry(line, version, type)
+      description = get_description(line)
+      ticket = get_ticket(line)
+      info = {
+        type: type,
+        ticket: ticket,
+        url: "",
+        description: description,
+        version: version,
+        tags: []
+      }.to_json
+      @entries << info
+    end
+
+    def parse_changelog
+      changelog_lines = File.readlines('CHANGELOG.md')
+      changelog_lines.each_with_index do |line, index|
+        line.strip!
+        if line.start_with?('## [')
+          @version = get_version(line)
+        elsif line.start_with?('###')
+          @type = get_type(line)
+        elsif line.start_with?('-')
+          create_entry(line, version, type)
+        elsif line.empty?
+        else
+          puts "Warning: Unexpected input at line #{index + 1}"
+        end
+      end
+    end
+
+    def write_to_files
+      @entries = @entries.uniq
+      @entries.each do |entry|
+        File.write(".changelog_entries/#{SecureRandom.hex}.json", entry)
+      end
+    end
+
+  end
+end

data/lib/chchchanges/version.rb

@@ -0,0 +1,3 @@
+module Chchchanges
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: chchchanges
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Zell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  chchchanges makes it convenient to create and maintain a proper CHANGELOG.
+                            Users can create CHANGELOG entries from the command line. Each entry is saved
+                            as in individual .json file which prevents CHANGELOG merge conflicts.
+email:
+- ericjzell@gmail.com
+executables:
+- chchchanges
+extensions: []
+extra_rdoc_files: []
+files:
+- ".changelog_entries/1192b2e6cfb3c57360e4a90adb105f24.json"
+- ".changelog_entries/66dcb740d4c86e3ba889d7831baf7d30.json"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chchchanges.gemspec
+- exe/chchchanges
+- lib/chchchanges.rb
+- lib/chchchanges/entry.rb
+- lib/chchchanges/generator.rb
+- lib/chchchanges/parser.rb
+- lib/chchchanges/version.rb
+homepage: https://github.com/EricJZell/chchchanges
+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.6.7
+signing_key: 
+specification_version: 4
+summary: chchchanges makes it convenient to create and maintain a proper CHANGELOG.
+test_files: []