allages 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 431112c7a324d6242c33172e228ba4499074974686305ddf7b345930d9c6c7e9
+  data.tar.gz: ca44e2c7a9a21968270d6c45eff530cbf26c54924e1f4d8ca433dc3549f6a32f
+SHA512:
+  metadata.gz: 4ad1c370f6286152d86ac169574ee24febe3560ac7cb9aea7d1ba82d7319cd2b38e36ac0267fd42fde105b41e66fe7222ff8e373f3b7581a3528df1fba099a4d
+  data.tar.gz: c48adace9593ab54b09a9014c5f925e87a52ac96e7377947b8178f3fbb3560fd47592273cfe92ecb305f698000f14bac6091018e8b68f95578ea2d6c513e6b0a

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.2

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 apantsiop@yahoo.gr. 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 allages.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,163 @@
+PATH
+  remote: .
+  specs:
+    allages (0.1.0)
+      rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.0)
+      actionpack (= 6.0.0)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.0)
+      actionpack (= 6.0.0)
+      activejob (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      mail (>= 2.7.1)
+    actionmailer (6.0.0)
+      actionpack (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.0)
+      actionview (= 6.0.0)
+      activesupport (= 6.0.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.0)
+      actionpack (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.0)
+      activesupport (= 6.0.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.0)
+      activesupport (= 6.0.0)
+      globalid (>= 0.3.6)
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activerecord (6.0.0)
+      activemodel (= 6.0.0)
+      activesupport (= 6.0.0)
+    activestorage (6.0.0)
+      actionpack (= 6.0.0)
+      activejob (= 6.0.0)
+      activerecord (= 6.0.0)
+      marcel (~> 0.3.1)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    builder (3.2.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.8.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.10.3)
+    nio4r (2.4.0)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.0)
+      actioncable (= 6.0.0)
+      actionmailbox (= 6.0.0)
+      actionmailer (= 6.0.0)
+      actionpack (= 6.0.0)
+      actiontext (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
+      activemodel (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      bundler (>= 1.3.0)
+      railties (= 6.0.0)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.2.0)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (6.0.0)
+      actionpack (= 6.0.0)
+      activesupport (= 6.0.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.1.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  allages!
+  bundler (~> 2.0)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+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,241 @@
+# Allages
+
+#### What Allages is?
+
+This gem was created to help maintain a changelog in a project.
+
+It can be used as a standalone utility for any kind of application or embedded as a gem in a RoR project.
+
+Allages generates a markdown changelog based on the keepachangelog.com format.
+
+"Allages" translates to "changes" in greek.
+
+#### So, why not use a simple markdown file?
+
+Keeping a changelog file for an application with many collaborators is hard due to conflicts that often occur. In order to avoid this messy situation, a directory based approach, with changes contained in their own file each, is a better alternative. No conflicts arise when merging feature/hotfix branches. Also, by using a simple script, one can generate a single CHANGELOG.md file by simply parsing the directory structure for entries.
+
+The directory tree convention that  looks like this (sample):
+
+```
+  changelogs
+  ├── 1.0.3
+  │   └── d4fe5be8-7237-4b40-854a-0e09f38be8ae.yml
+  ├── 1.0.4
+  │   ├── 531985ac-f3b4-4ba4-a257-31dabfdd9200.yml
+  │   └── bf701293-1620-4997-a728-3a50342407b8.yml
+  └── Unreleased
+      ├── 50267ff1-1047-4302-9843-19eeb79deea2.yml
+      └── d4fe5be8-7237-4b40-854a-0e09f38be8ae.yml
+```
+
+each subfolders under the /changelogs folder is considered a version. "Unreleased" is by convention the folder to keep all the new changelog entries that have not yet made it into a version.
+
+Each yaml file is a changelog entry. The name of the file has no effect on the entry description. If you use the handy rake task in order to create the entry, then a uuid named file is created which helps with resolving accidental conflicts. But you are free to use any other naming scheme, if you like. What is inside the yaml files is what matters:
+
+```
+date: 2019-08-22
+type: Added
+description: This is a nice addition to our app
+author: Tolis
+issue: 11
+dependencies:
+  - ~> backend-1.0.2
+  - -> solr-5.5
+```
+
+The above is a typical changelog entry.
+
+By using the markdown generator we get something like this:
+
+```
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+### Added
+- Another nice addition
+### Fixed
+- This was a bug, it is now fixed, issue: 67
+
+## 1.0.3
+### Fixed
+- This was a bug, it is now fixed, issue: 67
+
+## 1.0.4
+### Added
+- This is a nice addition to our app, issue: 11, dependencies: ~> backend-1.0.2, -> solr-5.5
+### Changed
+- This was wrong, so we changed it, issue: 89
+```
+
+
+## Installation
+
+##### For RoR projects
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'allages'
+```
+
+And then execute:
+
+    $ bundle
+
+##### For all other projects
+
+    $ gem install allages
+
+
+And generate the default tree structure with:
+
+##### For RoR projects
+
+```
+$ rails generate allages:init
+      create  config/initializers/allages.rb
+      create  changelogs
+      create  changelogs/Unreleased
+```
+
+##### For all other projects
+
+```
+$ allages init
+      create  .allages.yml
+      create  changelogs
+      create  changelogs/Unreleased
+```
+
+You can change the default allages configuration in your rails app.
+
+
+##### For RoR projects
+
+... by using an initializer. Like so:
+```
+Allages.configure do |config|
+  config.input_dir = 'changelogs'
+  config.output_file = :stdout
+  config.include_unreleased = true
+  config.header = <<~END
+  # Changelog
+  All notable changes to this project will be documented in this file.
+
+  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+  END
+end
+```
+
+##### For all other projects
+
+by editing the settings in the generated .allages.yml file:
+```
+input_dir: 'changelogs'
+output_file: 'CHANGELOG.md'
+include_unreleased: false
+header: |+
+  # Changelog
+  All notable changes to this project will be documented in this file.
+
+  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+```
+
+
+## Usage
+
+### Creating a new (unreleased) entry
+
+Just invoke the proper rake task with:
+##### For RoR projects
+
+```
+$ rake allages:new_entry
+```
+##### For all other projects
+
+```
+$ allages new_entry
+```
+And by giving the proper entry data:
+```
+Type (a)dded, (c)hanged, (f)ixed, (d)eprecated, (r)emoved, (s)ecurity: a
+Description: This is something new
+Author: Tolis
+Issue: 90
+Dependencies (comma seperated): one dep, then another one
+created new unreleased entry changelogs/Unreleased/f062f1cc-0d97-461f-928f-5c108c406d3f.yml
+```
+a new yaml file will created in the changelogs/Unreleased directory.
+
+### Creating a new version
+
+Creating a new version section for our changelog is as easy as creating a directory with the version name within /changelogs. But you can use a rake task for that:
+##### For RoR projects
+```
+$ rake allages:new_version
+```
+##### For all other projects
+```
+$ allages new_version
+```
+```
+Version name: 1.0.4
+created directory changelogs/1.0.4
+```
+By using the rake task you get a aditional hidden .meta.yml file within the created directory. This is for storing extra metadata (date, dependencies) regarding this version. You can edit this file manually. The extra metadata will be included in the version header of the generated markdown file. Leave the yaml values commented out if you don't want any metadata on your version descriptions.
+
+### Generating the CHANGELOG.md
+
+As expected, there's a rake task for that:
+##### For RoR projects
+```
+$ rake allages:generate
+```
+##### For all other projects
+```
+$ allages generate
+```
+The markdown will be output on the console if the reserved `:stdout` keyword is used, or in a file if a string was given in the configuration.
+
+### Version metadata
+
+By putting a .meta.yml file in the version folder you can add metadata such as date and dependencies in your changelog version/section headers:
+
+```
+date: 2019-08-22
+dependencies:
+  - dependency 1
+  - dependency 2
+```
+Then the version header generated will look like this:
+```
+## 1.0.4 - 2019-08-22 - dependencies: dependency 1, dependency 2
+```
+
+## TODO
+
+* A rake task to move entries from Unrealased to a new version
+* Write tests
+* Break the rails dependency
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/allages. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Allages project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/allages/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/allages.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "allages/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "allages"
+  spec.version       = Allages::VERSION
+  spec.authors       = ["Apostolos Pantsiopoulos"]
+  spec.email         = ["apantsiop@yahoo.gr"]
+
+  spec.summary       = %q{A rails gem to help with keeping a changelog for teams while minimizing git conflict issues}
+  spec.description   = %q{A rails gem to help with keeping a changelog for teams while minimizing git conflict issues}
+  spec.homepage      = "https://github.com/apantsiop/allages"
+  spec.license       = "MIT"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/apantsiop/allages"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = ["allages"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "allages"
+
+# 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(__FILE__)

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/exe/allages

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require 'rake'
+require 'rails/generators'
+require 'allages'
+
+spec = Gem::Specification.find_by_name 'allages'
+rakefile = "#{spec.gem_dir}/lib/allages/Rakefile"
+load rakefile
+
+task = ARGV[0]
+
+if File.file? ".allages.yml"
+  yaml = YAML.load_file ".allages.yml"
+  if yaml
+    Allages.configure do |config|
+      yaml.each do |setting, value|
+        config.send(setting + "=", value)
+      end
+    end
+  end
+end
+
+unless task
+  puts "No task was given"
+else
+  Rake::Task["allages:#{task}"].execute
+end

data/lib/allages.rb

@@ -0,0 +1,162 @@
+require "allages/version"
+require "allages/config"
+require "allages/railtie" if defined?(Rails)
+require 'securerandom'
+
+module Allages
+  class Error < StandardError; end
+
+  META_TEMPLATE = <<~META
+  # date: #{Time.now.strftime('%F')}
+  # dependencies:
+  # - dependency 1
+  # - dependency 2
+  META
+
+  def generate
+    sections = []
+
+    Dir.glob("#{Allages.config.input_dir}/*").each do |filename|
+      if File.directory? filename
+        section = {}
+        dir = File.basename filename
+        next if (dir == "Unreleased" && Allages.config.include_unreleased == false)
+        section[:name] = dir
+
+        if File.file? "#{filename}/.meta.yml"
+          section[:meta] = YAML.load_file "#{filename}/.meta.yml"
+        end
+
+        categories = {}
+        Dir.glob("#{filename}/*.yml").each do |entry_filename|
+          next if entry_filename.match? /\.meta\.yml/
+          entry = YAML.load_file entry_filename
+          if categories.has_key? entry['type']
+            categories[entry['type']] << entry
+          else
+            categories[entry['type']] = [entry]
+          end
+        end
+
+        section[:categories] = categories
+        sections << section
+      end
+    end
+
+    sections.sort! do |a, b|
+      if a[:name] == "Unreleased"
+        -1
+      elsif b[:name] == "Unreleased"
+        1
+      else
+        a[:name] <=> b[:name]
+      end
+    end
+
+    markdown = "#{Allages.config.header}"
+
+    had_previous_section = false
+    sections.each do |section|
+      markdown << "\n" if had_previous_section
+      had_previous_section = true
+      title = ["## #{section[:name]}"]
+      if section[:meta]
+        title << section[:meta]['date'] if section[:meta]['date']
+        title << "dependencies: #{section[:meta]['dependencies'].to_a.join(', ')}" unless section[:meta]['dependencies'].to_a.empty?
+      end
+      markdown << "#{title.join(' - ')}" << "\n"
+
+      section[:categories].each do |category, entries|
+        markdown << "### #{category}\n"
+
+        entries.each do |entry|
+          entry_md = [entry['description']]
+          entry_md << "issue: #{entry['issue']}" if entry['issue']
+          entry_md << "dependencies: #{entry['dependencies'].to_a.join(', ')}" unless entry['dependencies'].to_a.empty?
+          markdown << "- #{entry_md.join(', ')}\n"
+        end
+      end
+    end
+
+    if Allages.config.output_file.to_sym == :stdout
+      puts markdown
+    else
+      open(Allages.config.output_file, 'w') do |f|
+        f.puts markdown
+      end
+    end
+  end
+
+  module_function :generate
+
+  def new_version
+    print "Version name: "
+    STDOUT.flush
+    version = STDIN.gets.chomp
+    dir = "#{Allages.config.input_dir}/#{version}"
+    if File.directory?(dir)
+      puts "version already exists"
+      exit 1
+    else
+      FileUtils.mkdir_p(dir)
+      puts "created directory #{dir} "
+    end
+
+    open("#{dir}/.meta.yml", 'w') do |f|
+      f.puts META_TEMPLATE
+    end
+  end
+
+  module_function :new_version
+
+  def new_entry
+    types = {
+      "a" => "Added",
+      "c" => "Changed",
+      "f" => "Fixed",
+      "d" => "Deprecated",
+      "r" => "Removed",
+      "s" => "Security"
+    }
+
+    print "Type (a)dded, (c)hanged, (f)ixed, (d)eprecated, (r)emoved, (s)ecurity: "
+    STDOUT.flush
+    type = types[STDIN.gets.chomp]
+
+    print "Description: "
+    STDOUT.flush
+    description = STDIN.gets.chomp
+
+    print "Author: "
+    STDOUT.flush
+    author = STDIN.gets.chomp
+
+    print "Issue: "
+    STDOUT.flush
+    issue = STDIN.gets.chomp
+
+    print "Dependencies (comma seperated): "
+    STDOUT.flush
+    deps = STDIN.gets.chomp.split(',').map{|d| "  - #{d.chomp.lstrip}"}.join("\n")
+
+    yaml = <<~YAML
+    date: #{Time.now.strftime('%F')}
+    type: #{type}
+    description: #{description}
+    author: #{author}
+    issue: #{issue}
+    dependencies:
+    #{deps}
+    YAML
+
+    filename = "#{SecureRandom.uuid}.yml"
+    path = "#{Allages.config.input_dir}/Unreleased/#{filename}"
+
+    open("#{path}", 'w') do |f|
+      f.puts yaml
+    end
+    puts "created new unreleased entry #{path}"
+  end
+
+  module_function :new_entry
+end

data/lib/allages/Rakefile

@@ -0,0 +1,4 @@
+require 'allages'
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }

data/lib/allages/config.rb

@@ -0,0 +1,33 @@
+module Allages
+
+  def self.configure(&block)
+    yield @config ||= Allages::Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  class Configuration
+    attr_accessor :input_dir, :output_file, :include_unreleased, :header
+  end
+
+  def self.reset_config
+    self.configure do |config|
+      config.input_dir = 'changelogs'
+      config.output_file = :stdout
+      config.include_unreleased = false
+      config.header = <<~END
+      # Changelog
+      All notable changes to this project will be documented in this file.
+
+      The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+      and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+      END
+    end
+  end
+
+  reset_config()
+
+end

data/lib/allages/railtie.rb

@@ -0,0 +1,16 @@
+require 'rails'
+require 'rails/generators'
+require 'allages'
+require 'generators/init_generator'
+require 'generators/yaml_generator'
+
+module Allages
+  class Railtie < Rails::Railtie
+    railtie_name :allages
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/allages/tasks/allages.rake

@@ -0,0 +1,24 @@
+namespace :allages do
+
+  desc 'Initialize allages'
+  task :init => :environment do
+    puts defined?(Rails) ? "Rails exists" : "No rails"
+    Rails::Generators.invoke 'allages:yaml'
+  end
+
+  desc 'Generate changelog'
+  task :generate => :environment do
+    Allages.generate
+  end
+
+  desc 'Create new version'
+  task :new_version => :environment do
+    Allages.new_version
+  end
+
+  desc 'Create new entry'
+  task :new_entry => :environment do
+    Allages.new_entry
+  end
+
+end

data/lib/allages/version.rb

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

data/lib/generators/init_generator.rb

@@ -0,0 +1,30 @@
+require 'rails/generators/base'
+
+module Allages
+  class InitGenerator < Rails::Generators::Base
+    desc "This generator creates the nneded files for allages gem"
+
+    def create_initializer_file
+      create_file "config/initializers/allages.rb", <<~CONFIG
+      Allages.configure do |config|
+        # config.input_dir = 'changelogs'
+        # config.output_file = :stdout
+        # config.include_unreleased = false
+        # config.header = <<~END
+        # # Changelog
+        # All notable changes to this project will be documented in this file.
+
+        # The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+        # and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+        # END
+      end
+      CONFIG
+    end
+
+    def create_directories_structure
+      empty_directory Allages.config.input_dir
+      empty_directory "#{Allages.config.input_dir}/Unreleased"
+    end
+  end
+end

data/lib/generators/yaml_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators/base'
+
+module Allages
+  class YamlGenerator < Rails::Generators::Base
+    desc "This generator initializes the allages gem with this directory"
+
+    def create_initializer_file
+      create_file ".allages.yml", <<~CONFIG
+      # input_dir: 'changelogs'
+      # output_file: 'stdout'
+      # include_unreleased: false
+      # header: |+
+      #   # Changelog
+      #   All notable changes to this project will be documented in this file.
+      #
+      #   The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+      #   and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+      #
+      CONFIG
+    end
+
+    def create_directories_structure
+      empty_directory Allages.config.input_dir
+      empty_directory "#{Allages.config.input_dir}/Unreleased"
+    end
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: allages
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Apostolos Pantsiopoulos
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A rails gem to help with keeping a changelog for teams while minimizing
+  git conflict issues
+email:
+- apantsiop@yahoo.gr
+executables:
+- allages
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- allages.gemspec
+- bin/console
+- bin/setup
+- exe/allages
+- lib/allages.rb
+- lib/allages/Rakefile
+- lib/allages/config.rb
+- lib/allages/railtie.rb
+- lib/allages/tasks/allages.rake
+- lib/allages/version.rb
+- lib/generators/init_generator.rb
+- lib/generators/yaml_generator.rb
+homepage: https://github.com/apantsiop/allages
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/apantsiop/allages
+  source_code_uri: https://github.com/apantsiop/allages
+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.7.8
+signing_key: 
+specification_version: 4
+summary: A rails gem to help with keeping a changelog for teams while minimizing git
+  conflict issues
+test_files: []