logchange 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e6678b4bc69a5cdc2cab8bbc71ad0b43a33854a
+  data.tar.gz: 96c1905246dd6b04c4c99f576dea036514988e45
+SHA512:
+  metadata.gz: dca400cee181c2967a63099d8da0a86bcecc94612a4e40f28511e4a9ba24acf83c5a6eeaa4cce5e8f3404498c0a37d054ebc69928a7f1e896650704555fd7394
+  data.tar.gz: 5b45666ee97abb97ff566cb53da6f11b099f1bec94d8da8377ac8b321ee2c2647e7d54973217c6903d2defa30cd7af9c67e3f7a2ac127916676a7d485f3f6e80

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Hari Gopal
+
+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,77 @@
+# Logchange
+
+Logchange is an alternative approach to managing a _changelog_. Instead of writing to a flat `CHANGELOG(.md)`, it logs
+changes to `.yaml` files containing a `timestamp`, the `title`, and a boolean `public`.
+
+Logchange allows for two _release_ changelogs to be maintained - an exhaustive one for internal use, and a public one
+ to display to your users. It can _release_ a public and a private changelog with one command, assuming that `public`
+ boolean is correctly set (see _Usage_ section).
+
+This repository's _changelog_ is maintained using _logchange_. Since this is a public repository, there are only public
+changes. See the automatically generated `changelog/2017-public.yaml`. Unreleased changes go to `changelog/unreleased`.
+
+## Why?
+
+It's good to let your users know what you're up to, and it's good to keep track of what changed over time. However, you
+don't need to tell your users about every single change - hence the `public` flag. The _YAML_ format just makes it
+easier to parse and _present_ the data on the front-end, while being readable and editable.
+
+## Installation
+
+Add to your `Gemfile`:
+
+    gem 'logchange', '~> 0.1'
+
+And then:
+
+    $ bundle install
+
+Or install the gem with:
+
+    $ gem install logchange
+
+## Usage
+
+If you've just completed work on a feature, log it with:
+
+    $ logchange new "A cool new feature has been added"
+    Created [..]/changelog/unreleased/20170521-a-cool-new-feature-has-been-added.yml`
+
+This will create a new timestamped `.yaml` file in the `changelog` folder. By default, the `public` flag for all changes
+will be set to `true`. You can change this if you want to prevent it from appearing in the release log.
+
+To alter the default template used, create a `changelog/template.yaml` file, and set custom keys in it:
+
+    # changelog/template.yaml
+
+    public: false
+    github_issue: Add a link to related Github issue, or delete this key.
+
+If present, this template will be merged into the output.
+
+To _release_ all new _public_ changes to the flat file, run:
+
+    $ logchange release [VERSION]
+
+## Change template
+
+    ---
+    timestamp: 2017-05-21T06:45:08Z
+    title: The title for your change goes here. This string gets added to CHANGELOG.md upon release.
+    public: Defaults to 'true'. This means that the release command will add this change to CHANGELOG.md. Set to 'false' to prevent that.
+    additional_key_1: You can add any number of additional keys. Logchange will ignore these when writing CHANGELOG.md. Parsing / using these is up to you.
+
+## Development
+
+After checking out the repo, run `bundle install` 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/harigopal/logchange.
+
+## 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,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'logchange'
+
+require 'pry'
+Pry.start

data/bin/logchange

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'logchange'
+
+Logchange::Dispatch.new.execute

data/lib/logchange/configuration.rb

@@ -0,0 +1,16 @@
+module Logchange
+  # Store configuration for this gem.
+  class Configuration
+    attr_accessor :changelog_directory
+    attr_accessor :root_path
+
+    def initialize
+      @changelog_directory = 'changelog'
+      @root_path = Dir.pwd
+    end
+
+    def changelog_directory_path
+      File.join(@root_path, @changelog_directory)
+    end
+  end
+end

data/lib/logchange/dispatch.rb

@@ -0,0 +1,37 @@
+module Logchange
+  # Routes the user's command to appropriate handler.
+  class Dispatch
+    def execute
+      ensure_changelog_directory_exists unless command == :init
+
+      case command
+        when :init
+          Logchange::Initialize.new.execute
+        when :new
+          Logchange::Logger.new(ARGV[1]).execute
+        when :release
+          Logchange::Release.new.execute
+        else
+          raise "Unhandled command #{command}"
+      end
+    end
+
+    private
+
+    def ensure_changelog_directory_exists
+      path = File.join(Logchange.configuration.changelog_directory_path, 'unreleased')
+      return if File.directory?(path)
+      raise "The changelog directory does not exist in this path. Run 'logchange init', or change to the correct path."
+    end
+
+    def command
+      return ARGV[0].to_sym if %w[init new release preview].include?(ARGV[0])
+      print_help
+    end
+
+    def print_help
+      # TODO: Write actual help response.
+      raise 'Unknown command encountered.'
+    end
+  end
+end

data/lib/logchange/initialize.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+
+module Logchange
+  # Creates the changes directory if it doesn't exist, and logs the initialization.
+  class Initialize
+    def execute
+      path = File.join(Logchange.configuration.changelog_directory_path, 'unreleased')
+
+      if File.directory?(path)
+        puts 'The changelog directory already exists. Cancelling.'
+      else
+        FileUtils.mkdir_p(path)
+        Logchange::Logger.new('Added logchange to project.', public: false).execute
+      end
+    end
+  end
+end

data/lib/logchange/logger.rb

@@ -0,0 +1,52 @@
+require 'yaml'
+require 'time'
+
+module Logchange
+  # Logs a new change.
+  class Logger
+    def initialize(title, public: true)
+      @title = title
+      @public = public
+    end
+
+    def execute
+      file_path = File.join(unreleased_path, filename)
+      File.write(file_path, log_contents)
+      puts "Created #{file_path}"
+    end
+
+    private
+
+    def log_contents
+      YAML.dump({
+        'timestamp' => Time.now.utc.iso8601,
+        'title' => @title,
+        'public' => @public
+      }.merge(template))
+    end
+
+    def template
+      template_path = File.join(Logchange.configuration.changelog_directory_path, 'template.yaml')
+      return {} unless File.exists?(template_path)
+      YAML.load(File.read(template_path))
+    end
+
+    def filename
+      "#{datetime}-#{simplified_title}.yaml"
+    end
+
+    def simplified_title
+      spaces_dashed = @title.tr(' ', '-')
+      specials_removed = spaces_dashed.gsub(/[^\-0-9A-Za-z]/, '')[0..60]
+      specials_removed.downcase
+    end
+
+    def unreleased_path
+      File.join(Logchange.configuration.changelog_directory_path, 'unreleased')
+    end
+
+    def datetime
+      "#{Time.now.utc.year}#{Time.now.utc.month.to_s.rjust(2, '0')}#{Time.now.utc.day.to_s.rjust(2, '0')}"
+    end
+  end
+end

data/lib/logchange/release.rb

@@ -0,0 +1,12 @@
+require 'fileutils'
+require 'yaml'
+require 'time'
+
+module Logchange
+  # Releases new changes to a markdown log.
+  class Release
+    def execute
+      raise 'This is a TODO!'
+    end
+  end
+end

data/lib/logchange/version.rb

@@ -0,0 +1,3 @@
+module Logchange
+  VERSION = -'0.0.1'
+end

data/lib/logchange.rb

@@ -0,0 +1,19 @@
+require 'logchange/version'
+require 'logchange/configuration'
+require 'logchange/dispatch'
+require 'logchange/initialize'
+require 'logchange/logger'
+
+module Logchange
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Logchange::Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/logchange.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logchange/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'logchange'
+  spec.version = Logchange::VERSION
+  spec.authors = ['Hari Gopal']
+  spec.email   = ['mail@harigopal.in']
+
+  spec.summary     = 'An alternative approach to managing a changelog.'
+  spec.description = 'Logs changes to individual YAML files and offers a release mechanism.'
+  spec.homepage    = 'https://github.com/harigopal/logchange'
+  spec.license     = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.required_ruby_version = '>= 2.2.0'
+  spec.bindir                = 'exe'
+  spec.executables           = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths         = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: logchange
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hari Gopal
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Logs changes to individual YAML files and offers a release mechanism.
+email:
+- mail@harigopal.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/logchange
+- lib/logchange.rb
+- lib/logchange/configuration.rb
+- lib/logchange/dispatch.rb
+- lib/logchange/initialize.rb
+- lib/logchange/logger.rb
+- lib/logchange/release.rb
+- lib/logchange/version.rb
+- logchange.gemspec
+homepage: https://github.com/harigopal/logchange
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: An alternative approach to managing a changelog.
+test_files: []