structured_changelog 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dea3018dfd30c8f5c93bd4fcec90fe1ccb9eb818
+  data.tar.gz: 461a9a2bc2f094daa0b95a30712f2fd9f05b05df
+SHA512:
+  metadata.gz: d02a7e367a64cae7308b2ed63e8c82439c36adc10b8a75b865aed0b669afe729eb8e4a95febdb331acb554c31915c91b8511dfd1397e37f3888d52e14c8b869e
+  data.tar.gz: 12559d6bb09a05a4d950bea565cffb64cc4194c2d5c17b86ed520345d0d52fb1bc6e005cdda4208dddbedb0d8430925d1cf329b21941bcfd09280241a22153ce

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+## ROADMAP 0.4.0
+
+* FEATURE validation requires BREAKING/FEATURE/FIX prefixes for each line
+
+## ROADMAP 0.3.0
+
+* FEATURE include a rake task
+
+## RELEASE 0.2.0
+
+* FEATURE handle ROADMAP blocks
+
+## RELEASE 0.1.0
+
+* FEATURE handle RELEASE blocks

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 choffman@optoro.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 structured_changelog.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# StructuredChangelog
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/structured_changelog`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'structured_changelog'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install structured_changelog
+
+## 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]/structured_changelog. 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.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "structured_changelog"
+
+# 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/lib/structured_changelog/release.rb

@@ -0,0 +1,31 @@
+class StructuredChangelog
+  class Release
+    def self.pattern
+      /^## RELEASE (?<version>\d+\.\d+\.\d+)$/
+    end
+
+    def initialize(contents)
+      @contents = contents
+    end
+
+    def validate
+      notifications = []
+
+      notifications << "No version number" if version.nil?
+
+      notifications
+    end
+
+    def version
+      contents.match(self.class.pattern)[:version]
+    end
+
+    def <=>(release)
+      version <=> release.version
+    end
+
+    private
+
+    attr_reader :contents
+  end
+end

data/lib/structured_changelog/roadmap.rb

@@ -0,0 +1,23 @@
+class StructuredChangelog
+  class Roadmap
+    def self.pattern
+      /^## ROADMAP (?<version>\d+\.\d+\.\d+)$/
+    end
+
+    def <=>(roadmap)
+      version <=> roadmap.version
+    end
+
+    def initialize(contents)
+      @contents = contents
+    end
+
+    def version
+      contents.match(self.class.pattern)[:version]
+    end
+
+    private
+
+    attr_reader :contents
+  end
+end

data/lib/structured_changelog/task.rb

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'structured_changelog'
+
+desc 'Validate your Structured Changelog'
+task 'structured_changelog:validate', [:path] do |_task, arguments|
+  path = arguments.to_h.fetch(:path) { Pathname.pwd/"CHANGELOG.md" }
+
+  StructuredChangelog.new(path).validate
+end
+
+if (guard_clean_task = Rake::Task['release:guard_clean'])
+  guard_clean_task.enhance(['structured_changelog:validate'])
+elsif (release_task = Rake::Task['release'])
+  release_task.enhance(['structured_changelog:validate'])
+end

data/lib/structured_changelog.rb

@@ -0,0 +1,60 @@
+require 'pathname'
+require 'structured_changelog/release'
+require 'structured_changelog/roadmap'
+
+class StructuredChangelog
+  attr_reader :path, :releases, :roadmaps
+
+  def initialize(path)
+    @path = Pathname.new(path)
+
+    @releases = Set.new([])
+    @roadmaps = Set.new([])
+
+    parse
+  end
+
+  def version
+    latest_release.version
+  end
+
+  def validate
+    notifications = []
+
+    if latest_release.nil?
+      notifications << "No RELEASE blocks"
+    else
+      notifications += latest_release.validate
+    end
+
+    notifications.each(&method(:puts))
+
+    notifications.empty?
+  end
+
+  private
+
+  def latest_release
+    releases.max
+  end
+
+  def parse
+    capture = []
+
+    [*path.readlines, :EOF].each do |line|
+      if line == :EOF || line =~ Roadmap.pattern || line =~ Release.pattern
+        if capture.first =~ Roadmap.pattern
+          roadmaps << Roadmap.new(capture.join)
+          capture = []
+        elsif capture.first =~ Release.pattern
+          releases << Release.new(capture.join)
+          capture = []
+        end
+      end
+
+      capture << line
+    end
+
+    self
+  end
+end

data/structured_changelog.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'structured_changelog'
+
+Gem::Specification.new do |spec|
+  spec.name          = "structured_changelog"
+  spec.version       = StructuredChangelog.new("CHANGELOG.md").version
+  spec.authors       = ["Chris Hoffman"]
+  spec.email         = ["yarmiganosca@gmail.com"]
+
+  spec.summary       = %q{A useful changelog for a change}
+  spec.description   = "Psychological manipulation designed to get programmers to right changelogs."
+  spec.homepage      = "https://www.github.com/yarmiganosca/structured_changelog"
+
+  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"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "fantaskspec"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: structured_changelog
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Chris Hoffman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-12 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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: fantaskspec
+  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: Psychological manipulation designed to get programmers to right changelogs.
+email:
+- yarmiganosca@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/structured_changelog.rb
+- lib/structured_changelog/release.rb
+- lib/structured_changelog/roadmap.rb
+- lib/structured_changelog/task.rb
+- structured_changelog.gemspec
+homepage: https://www.github.com/yarmiganosca/structured_changelog
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A useful changelog for a change
+test_files: []