codelog 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a8af4bf07044d067f6f00a6e08f346c9fa58747
+  data.tar.gz: 1eb207cad96a79dafbefb197108dec71d122fcd1
+SHA512:
+  metadata.gz: 4dfcb4950c72183f4de9a230a10d081050857a0a8747980c9d3f81676af9dd8129715560786809aaab11d424907d1e08842518744994e9cfc4ecfb9f889007b0
+  data.tar.gz: 336f554944b2cc621c11a033f316efb13de3b8d26d957cc9d728043c200965d4ec6003ec4804e2af87bfbf1da132d6dbaa334238032e8a0105e0f0697bd66812

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+  All notable changes to this project will be documented in this file.
+  The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+  and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+            
+## 0.2.2
+### Changed
+- Setup command copies a template.yml with an example data.
+- Required files to gemspec
+- Setup generates a gitkeep file
+
+---
+## 0.2.1
+### Removed
+- Unnecessary code on bin
+
+---
+## 0.2.0
+### Added
+- Command Line Interface (CLI) through Thor
+- Rubocop
+- Changelog
+- Contributing guide
+- License
+- Code of conduct
+- CodeClimate
+- CI through Travis
+
+### Changed
+- All commands now are called by `codelog` command
+- Updated README.md
+
+### Removed
+- Separated command to create release without deleting unreleased files
+- Separated command to delete unreleased files
+- Separated command to update changelog without releasing new version
+
+---
+## 0.1.0
+### Added
+- Automated setup to create folder structure and template
+- Automated Changelog generator
+- Automated Release file generator
+- Automated Change file generator
+- Automated unreleased files deletion
+- Command to full Changelog generation flow
+
+---

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# 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 opensource@codus.com.br. The project team will review and investigate all complaints, and will respond in a way that it deems 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/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# How to contribute to CodeLog
+
+We at Codus welcome all kinds of contributions. By participating you agree to follow our [code of conduct].
+
+If you find an issue, have an idea for a new feature or any improvement, we would like to hear from you. You can report these as issues or submit pull requests. In order to help us maintain an organized process, please read the following guidelines before submiting any of those.
+
+## Reporting Issues
+
+Before reporting new issues, please verify if there are existing issues for the same problem by searching at [issues].
+
+To help us attend you quickly, please make sure to give a clear name to the issue and to describe it with all relevant information. Giving examples can help us understand your suggestion or, in case of issues, reproduce the problem.
+
+## Sending Pull Requests
+
+First check the Network at Insights tab to see if there are anyone already working on the same feature/fix you want to submit.
+
+Then look at [issues] to see if there are any related issues that your feature/fix should consider. If there are none, please create one describing your implementations intent. You should always mention a related issue in the pull request description.
+
+While writing code, follow the code conventions that you find in the existing code. It make it easier to read. Try to write short, clear and objective commit messages too. You can squash your commits and improve your commit messages once your done.
+
+Also make sure to add good tests to your new code. Only refactoring of tested features and documentation do not need new tests. These way your changes will be documented and future changes will not break what you added.
+
+### Step-by-step
+
+- Fork the repository.
+- Commit and push until your are proud of what you have done.
+- Execute the full test suite to ensure all is passing.
+- Make sure your code does not produce RuboCop offenses.
+- Squash commits if necessary.
+- If what you are submit is a noteworthy change, then create a [change] for us to add to the release notes. If you are not sure, create a change anyway.
+- Push to your repository.
+- Open a pull request to the master of the gem's repository.
+- Give your pull request a good description. Do not forget to mention a related issue.
+
+## Running Tests
+
+Once you cloned the gem at your local machine you should run the following command at its root folder:
+
+``` bash
+$ bundle
+```
+
+After that, you can execute the tests suite by running the following command at the root folder:
+
+``` bash
+$ rspec
+```
+
+## Adding entry to Changelog
+
+As we can add more than one pull request in a release, we ask you to simply add a change file living us to generate the release file and update the changelog. You can do it by following the following steps:
+
+- Run `codelog new`.
+- Describe your changes in the generated change file following the template.
+- Commit it too.
+
+Not every change should be a entry in the changelog. Only the ones that impact end users.
+We use and recommend the changelog format proposed at [Keep a Changelog].
+
+[code of conduct]: https://github.com/codus/codelog/blob/master/CODE_OF_CONDUCT.md
+[issues]: https://github.com/codus/codelog/issues
+[change]: #adding-entry-to-changelog
+[Keep a Changelog]: http://keepachangelog.com/en/1.0.0/

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Codus Tecnologia
+
+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,106 @@
+![CodeLog logo](https://raw.githubusercontent.com/codus/codelog/master/codelog.png)
+
+[![Build Status](https://travis-ci.org/codus/codelog.svg?branch=master)](https://travis-ci.org/codus/codelog)
+[![Maintainability](https://api.codeclimate.com/v1/badges/6f5885536c6b5c82f304/maintainability)](https://codeclimate.com/github/codus/codelog/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/6f5885536c6b5c82f304/test_coverage)](https://codeclimate.com/github/codus/codelog/test_coverage)
+
+This gem provides a simple way to manage changelogs, avoiding conflicts and missplaced informations. Changes are handled as if they were "migrations" and built when releasing a version, allowing a more precise knowledge of what changes were made to what version.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'codelog'
+```
+
+And then execute:
+
+``` bash
+$ bundle
+```
+
+Or install it yourself as:
+
+``` bash
+$ gem install codelog
+```
+
+## Setup
+
+After the installation run the following command to generate the `changelogs` folder structure and the `template.yml` file:
+
+``` bash
+$ codelog setup
+```
+
+The `template.yml` file will be used to create a new change file. Change files from `unreleased` folder will compose the next release file when generated.
+You should populate this template with the sections and topic examples desired for describe the current release that will be later added in the `CHANGELOG.md` file.
+The template can be as the following example:
+
+```yaml
+"Added":
+  - New features implemented
+
+"Changed":
+  - Changes to existing feature
+
+"Deprecated":
+  - Features that are soon to be removed
+
+"Removed":
+  - Features that were removed
+
+"Fixed":
+  - Changes to broken code
+
+"Security":
+  - Changes that fix vulnerabilities
+
+"Deploy notes":
+  - Changes that should impact the deploy process and what should be made before it
+```
+
+## Usage
+
+After the initial setup every time a change is made, the user should run the following command in the project root path:
+
+``` bash
+$ codelog new
+```
+
+This will generate a change file on `changelogs/unreleased/` from the `template.yml` named with a timestamp value followed by `_change.yml`.
+
+The new change file should be filled with informations about the implemented change, all unused topics should be erased and the file committed.
+
+When closing a version you should run the following command:
+
+``` bash
+$ codelog release {x.y.z}
+```
+
+It will execute 3 steps:
+
+- Generate a new release file at `changelogs/releases/` by merging all change files at `changelogs/unreleased/`
+- Deletes the change files at `changelogs/unreleased/` because they now compose the new release. If it was not deleted, the change would appear repeated in the next release.
+- Updates the `CHANGELOG.md` file by merging all the releases at `changelogs/releases/`.
+
+## Contributing
+
+Issue reports and pull requests are welcome on GitHub at https://github.com/codus/codelog. Read our [Contributing guide] for instructions on how to do it.
+
+## Supported Ruby Versions
+
+- Ruby 2.1.10+
+- JRuby 9.1.14.0+
+
+## License
+
+This software was released under MIT License. Read [License] for further informations.
+
+Copyright 2018 Codus. http://www.codus.com.br
+
+You are not granted rights or licenses to the trademarks of Codus, including without limitation the Codelog name or logo.
+
+[Contributing guide]: https://github.com/codus/codelog/blob/master/CONTRIBUTING.md
+[License]: https://github.com/codus/codelog/blob/master/LICENSE

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/codelog

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'codelog'
+
+Codelog::CLI.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/lib/codelog.rb

@@ -0,0 +1,8 @@
+require 'codelog/version'
+require 'codelog/cli'
+require 'codelog/command/setup'
+require 'codelog/command/new'
+require 'codelog/command/release'
+require 'codelog/command/step/changelog'
+require 'codelog/command/step/delete'
+require 'codelog/command/step/version'

data/lib/codelog/cli.rb

@@ -0,0 +1,21 @@
+require 'thor'
+
+module Codelog
+  class CLI < Thor
+    desc 'setup', 'Generate the changelogs folder structure and the template.yml file'
+    def setup
+      Codelog::Command::Setup.run
+    end
+
+    desc 'new', 'Generate a file from the template for the unreleased changes'
+    method_option :change, aliases: '-c', default: true, desc: 'Create a change file'
+    def new
+      Codelog::Command::New.run
+    end
+
+    desc 'release [VERSION]', 'Generate new release updating changelog'
+    def release(version_number)
+      Codelog::Command::Release.run version_number
+    end
+  end
+end

data/lib/codelog/command/new.rb

@@ -0,0 +1,30 @@
+require 'fileutils'
+
+module Codelog
+  module Command
+    class New
+      include FileUtils
+
+      def self.run
+        Codelog::Command::New.new.run
+      end
+
+      def run
+        chdir Dir.pwd do
+          # This script create a change file for the changelog documentation.
+
+          full_file_name = "changelogs/unreleased/#{Time.now.to_i}_change.yml"
+
+          puts "== Creating #{full_file_name} change file based on example =="
+          system! "cp changelogs/template.yml #{full_file_name}"
+        end
+      end
+
+      private
+
+      def system!(*args)
+        system(*args) || abort("\n== Command #{args} failed ==")
+      end
+    end
+  end
+end

data/lib/codelog/command/release.rb

@@ -0,0 +1,15 @@
+module Codelog
+  module Command
+    class Release
+      def self.run(version_number)
+        Codelog::Command::Release.new.run version_number
+      end
+
+      def run(version_number)
+        Codelog::Command::Step::Version.run version_number
+        Codelog::Command::Step::Delete.run
+        Codelog::Command::Step::Changelog.run
+      end
+    end
+  end
+end

data/lib/codelog/command/setup.rb

@@ -0,0 +1,34 @@
+require 'fileutils'
+
+module Codelog
+  module Command
+    class Setup
+      include FileUtils
+
+      TEMPLATE_FILE_PATH = File.dirname(__FILE__) + '/../../fixtures/template.yml'
+
+      def self.run
+        Codelog::Command::Setup.new.run
+      end
+
+      def run
+        chdir Dir.pwd do
+          # This script provides the initial setup for the gem usage.
+
+          puts '== Creating folder structure and template =='
+          system! 'mkdir changelogs/'
+          system! 'mkdir changelogs/unreleased'
+          system! 'mkdir changelogs/releases'
+          system! "cp #{TEMPLATE_FILE_PATH} changelogs/template.yml"
+          system! 'touch changelogs/unreleased/.gitkeep'
+        end
+      end
+
+      private
+
+      def system!(*args)
+        system(*args) || abort("\n== Command #{args} failed ==")
+      end
+    end
+  end
+end

data/lib/codelog/command/step/changelog.rb

@@ -0,0 +1,45 @@
+require 'fileutils'
+
+module Codelog
+  module Command
+    module Step
+      class Changelog
+        include FileUtils
+
+        def self.run
+          Codelog::Command::Step::Changelog.new.run
+        end
+
+        def run
+          chdir Dir.pwd do
+            create_file_from changes
+          end
+        end
+
+        private
+
+        def changes
+          version_changelogs = Dir['changelogs/releases/*.md']
+          version_changelogs.sort_by! do |file_name|
+            version_number = file_name.split('/').last.chomp('.md')
+            Gem::Version.new(version_number)
+          end.reverse!
+          version_changelogs.inject([]) do |partial_changes, version_changelog|
+            partial_changes + File.readlines(version_changelog)
+          end
+        end
+
+        def create_file_from(changes)
+          File.open('CHANGELOG.md', 'w+') do |f|
+            f.puts %(# Changelog
+  All notable changes to this project will be documented in this file.
+  The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+  and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+            )
+            f.puts(changes)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/codelog/command/step/delete.rb

@@ -0,0 +1,21 @@
+require 'fileutils'
+
+module Codelog
+  module Command
+    module Step
+      class Delete
+        include FileUtils
+
+        def self.run
+          Codelog::Command::Step::Delete.new.run
+        end
+
+        def run
+          chdir Dir.pwd do
+            system('rm -rv changelogs/unreleased/*.yml')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/codelog/command/step/version.rb

@@ -0,0 +1,51 @@
+require 'yaml'
+require 'fileutils'
+
+module Codelog
+  module Command
+    module Step
+      class Version
+        include FileUtils
+
+        def initialize(version)
+          @version = version
+        end
+
+        def self.run(version)
+          Codelog::Command::Step::Version.new(version).run
+        end
+
+        def run
+          abort('ERROR: Please enter a version number') if @version.nil?
+          chdir Dir.pwd do
+            create_version_changelog_from changes_hash
+          end
+        end
+
+        private
+
+        def changes_hash
+          change_files_paths = Dir['changelogs/unreleased/*.yml']
+          change_files_paths.inject({}) do |all_changes, change_file|
+            changes_per_category = YAML.load_file(change_file)
+            all_changes.merge!(changes_per_category) do |category, changes, changes_to_be_added|
+              changes | changes_to_be_added
+            end
+          end
+        end
+
+        def create_version_changelog_from(changes_hash)
+          File.open("changelogs/releases/#{@version}.md", 'a') do |line|
+            line.puts "## #{@version}"
+            changes_hash.each do |category, changes|
+              line.puts "### #{category}"
+              changes.each { |change| line.puts "- #{change}" }
+              line.puts "\n"
+            end
+            line.puts "---\n"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/codelog/version.rb

@@ -0,0 +1,3 @@
+module Codelog
+  VERSION = '0.2.2'.freeze
+end

data/lib/fixtures/template.yml

@@ -0,0 +1,20 @@
+"Added":
+  - New features implemented
+
+"Changed":
+  - Changes to existing feature
+
+"Deprecated":
+  - Features that are soon to be removed
+
+"Removed":
+  - Features that were removed
+
+"Fixed":
+  - Changes to broken code
+
+"Security":
+  - Changes that fix vulnerabilities
+
+"Deploy notes":
+  - Changes that should impact the deploy process and what should be made before it

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: codelog
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Luís Bevilacqua
+- Rodrigo Masaru
+- Fernanda Thomazinho
+- Celso Crivelaro
+- Vinicius Oyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple to use gem made to help managing changelogs avoiding conflicts
+  and missplaced changes
+email:
+- opensource@codus.com.br
+executables:
+- codelog
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- Rakefile
+- bin/codelog
+- bin/setup
+- lib/codelog.rb
+- lib/codelog/cli.rb
+- lib/codelog/command/new.rb
+- lib/codelog/command/release.rb
+- lib/codelog/command/setup.rb
+- lib/codelog/command/step/changelog.rb
+- lib/codelog/command/step/delete.rb
+- lib/codelog/command/step/version.rb
+- lib/codelog/version.rb
+- lib/fixtures/template.yml
+homepage: https://github.com/codus/codelog
+licenses:
+- MIT
+metadata: {}
+post_install_message: To start using the codelog run `codelog setup` and fill the
+  `template.yml` file
+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.13
+signing_key: 
+specification_version: 4
+summary: A gem to help with changelog management
+test_files: []