clemency 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c46fdde5c2da4ed4d002c6272ad3473e99b88bebf51405b01e7f2bc206345290
-  data.tar.gz: 70c33ce94b1887dcb03d3f1cbd2a98424647cc4b347910226d4b823df01c49f1
+  metadata.gz: 2efdabed6d5159d35dde521f624561f01eba89ab8a64ca11dca7be11fb9367c7
+  data.tar.gz: 1f2d2c96af18e5374c6a15f80453fd9ac1dfd83b79ce290c5540594185aa4deb
 SHA512:
-  metadata.gz: 2b0323be4e90e29eee6ebcd5aecf579e7c3b0667bddea70473f572567c83d3da7ad1ccd5a47d67ea426a59631436819ff7699085885f2dd93aba523970f81fe2
-  data.tar.gz: d59beb708c3cf10462a389d3e74f44860d8fd3ae14ee10a2218f60e2a86614cb4cd9fec541dfc852bf31046d3cdc2de8d326ea20f9b4353972a41393d58b96df
+  metadata.gz: bdd9a28d76542ae43278f24f7fa53c14922e48433a2094e60dc6dbe380b5a2725e4c9702daf396c5e73bbdaf57f2d9f6a07f9e8b7d294fb93861456e4c6b1ee0
+  data.tar.gz: d43e5b3deeb4de33bdf1a0d4896b5aaaab0579222ee4f0793c8b7f263d4663022a3e3363e9135bdb6335ce900a19d7efff14dbb0f756baccb5679677da7ca555

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    clemency (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.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.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  clemency!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -22,7 +22,36 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Installs the configuration file:
+
+    $ rails g clemency:install
+
+Create a new release (Generates a new release file in RAILS_ROOT/releases folder):
+
+    $ rails g clemency:release 1.1.0
+
+Migrate to a specific release:
+
+    $ rails clemency:migrate -> calls the up callback on the current release as defined in .version
+    $ rails clemency:migrate[1.1.0] -> calls the up callback on the 1.1.0 release
+    $ [NOT IMPLEMENTED] rails clemency:migrate[1.0.0-1.1.0] -> calls the up callback on all releases between 1.0.0 and 1.1.0
+
+Rollback to a specific release:
+
+    $ rails clemency:rollback -> calls the down callback on the current release as defined in .version
+    $ rails clemency:rollback[1.1.0] -> calls the down callback on the 1.1.0 release
+    $ [NOT IMPLEMENTED] rails clemency:rollback[1.1.0-1.0.0] -> calls the down callback on all releases between 1.1.0 and 1.0.0
+
+Generate a changelog for a specific release:
+
+    $ rails clemency:changelog -> generates a changelog the current release as defined in .version
+    $ rails clemency:changelog[1.1.0] -> generates a changelog for the 1.1.0 release
+    $ [NOT IMPLEMENTED] rails clemency:changelog[1.1.0-1.0.0] -> generates a changelog for all releases between 1.1.0 and 1.0.0
+
+## TODO
+
+- add more specs
+- implement rake tasks that execute a series of release tasks
 
 ## Development
 
@@ -32,7 +61,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/clemency.
+Bug reports and pull requests are welcome on GitHub at https://github.com/leftplusrightllc/clemency.
 
 ## License
 

data/clemency.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   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/lib/clemency.rb

@@ -1,6 +1,76 @@
 require "clemency/version"
+require "clemency/callbacks"
+require "clemency/configuration"
+require "clemency/changelog"
+require "clemency/release"
+require 'clemency/railtie' if defined?(Rails)
 
 module Clemency
+
   class Error < StandardError; end
-  # Your code goes here...
+
+  @releases = {}
+  @config = Configuration.new
+
+  def self.config
+    @config
+  end
+
+  def self.releases
+    @releases
+  end
+
+  def self.define_release(&blk)
+      release = Release.new
+      release.instance_eval(&blk)
+      Clemency.releases[release.get(:version)] = release
+      release
+  end
+
+  def self.load_config
+    load "#{Rails.root}/config/clemency.rb"
+  end
+
+  def self.latest_release
+    latest_verion = @releases.keys.sort{|a, b| Gem::Version.new(a) <=>  Gem::Version.new(b) }.last
+    puts latest_verion
+    @releases.fetch(latest_verion, nil)
+  end
+
+  def self.load_release_files
+    Dir.glob("#{Rails.root}/releases/*.rb").each { |f| load f }
+  end
+
+  def self.configure(&blk)
+    @config.instance_eval(&blk)
+  end
+
+  def self.migrate!(version)
+    puts "Clemency is migrating release #{version}"
+    release = @releases.fetch(version, nil)
+    if release.nil?
+      puts "We could not find release #{version}"
+      return
+    end
+    @config.call!(:before_up, release)
+    release.call!(:up, release)
+    @config.call!(:after_up, release)
+  end
+
+  def self.rollback!(version)
+    puts "Clemency is migrating release #{version}"
+    release = @releases.fetch(version, nil)
+    if release.nil?
+      puts "We could not find release #{version}"
+      return
+    end
+    @config.call!(:before_down, release)
+    release.call!(:down, release)
+    @config.call!(:after_down, release)
+  end
+
+  def self.to_markdown
+      @releases.map { |release| release.to_markdown }.join("\n\n")
+  end
+
 end

data/lib/clemency/callbacks.rb

@@ -0,0 +1,23 @@
+module Clemency
+
+  class Callbacks
+
+    def initialize
+      @callbacks = {}
+    end
+
+    def call!(key, *args)
+      get(key).call(*args)
+    end
+
+    def get(key)
+      @callbacks.fetch(key, Proc.new {})
+    end
+
+    def set(key, callback)
+      @callbacks[key] = callback
+    end
+
+  end
+
+end

data/lib/clemency/changelog.rb

@@ -0,0 +1,27 @@
+class Changelog
+
+  attr_reader :items
+
+  def initialize
+    @items = Hash.new { |h, k| h[k] = [] }
+  end
+
+  def fixed(item)
+    @items[:fixed] << item
+  end
+
+  def added(item)
+    @items[:added] << item
+  end
+
+  def changed(item)
+    @items[:changed] << item
+  end
+
+  def to_markdown
+    @items.map do |type, items|
+      "####{type.upcase}\n" + items.map { |item| "- #{item}"}.join("\n")
+    end.join("\n\n")
+  end
+
+end

data/lib/clemency/configuration.rb

@@ -0,0 +1,24 @@
+require 'forwardable'
+
+module Clemency
+  class Configuration
+    extend Forwardable
+    def_delegators :@callbacks, :call!
+    attr_reader :callbacks
+    def initialize
+      @callbacks = Callbacks.new
+    end
+    def before_up(&blk)
+      @callbacks.set(:before_up, blk)
+    end
+    def after_up(&blk)
+      @callbacks.set(:after_up, blk)
+    end
+    def before_down(&blk)
+      @callbacks.set(:before_down, blk)
+    end
+    def after_down(&blk)
+      @callbacks.set(:after_down, blk)
+    end
+  end
+end

data/lib/clemency/railtie.rb

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

data/lib/clemency/release.rb

@@ -0,0 +1,51 @@
+require 'forwardable'
+
+module Clemency
+
+  class Release
+    extend Forwardable
+
+    def_delegators :@callbacks, :call!
+
+    attr_reader :callbacks
+
+    def initialize
+      @config = {}
+      @changelog = Changelog.new
+      @callbacks = Callbacks.new
+    end
+
+    def set(key, value)
+      @config[key] = value
+    end
+
+    def get(key, default = nil)
+      @config.fetch(key, default)
+    end
+
+    def changelog(&blk)
+      if block_given?
+        @changelog.instance_eval(&blk)
+      else
+        @changelog
+      end
+    end
+
+    def up(&blk)
+      @callbacks.set(:up, blk)
+    end
+
+    def down(&blk)
+      @callbacks.set(:down, blk)
+    end
+
+    def to_markdown
+      %Q(##[#{get(:version)}] - #{Time.now.strftime("%D")}
+
+#{@changelog.to_markdown}
+      )
+    end
+
+  end
+
+end

data/lib/clemency/tasks/clemency.rake

@@ -0,0 +1,48 @@
+require "clemency"
+
+namespace :clemency do
+
+  # TODO: Refactor the migrate and rollback - loads of duplication...
+
+  desc "Migrates a specific release version"
+  task :migrate, [:version] => [:environment] do |t, args|
+    version = args[:version]
+    if version.nil?
+      version = File.read("#{Rails.root}/.version").to_s.strip
+    end
+    Clemency.load_config
+    Clemency.load_release_files
+    Clemency.migrate!(version)
+  end
+
+  desc "Rollback a specific release version"
+  task :rollback, [:version] => [:environment] do |t, args|
+    version = args[:version]
+    if version.nil?
+      version = File.read("#{Rails.root}/.version").to_s.strip
+    end
+    Clemency.load_config
+    Clemency.load_release_files
+    Clemency.rollback!(version)
+  end
+
+  desc "Generate changelog for a release"
+  task :changelog, [:version] => [:environment] do |t, args|
+    version = args[:version]
+    if version.nil?
+      version = File.read("#{Rails.root}/.version").to_s.strip
+    end
+    puts "Clemency is generating a changelog for release #{version}"
+    Clemency.load_release_files
+    release = Clemency.releases.fetch(version, nil)
+    if release.nil?
+      puts "We could not find release #{version}"
+      next
+    end
+    puts release.to_markdown
+  end
+
+
+
+
+end

data/lib/clemency/version.rb

@@ -1,3 +1,3 @@
 module Clemency
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/generators/clemency/install_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators/base'
+
+module Clemency
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      desc "Installs Clemency's configuration file"
+      def create_release_file
+        config_file = %Q(#add gem "slack-notifier" to your Gemfile
+#notifier = Slack::Notifier.new "WEBHOOK_URL"
+Clemency.configure do
+  before_up do |release|
+    #execute code before every migration
+  end
+  after_up do |release|
+    #execute code after every migration
+    #message = release.to_markdown
+    #notifier.post(text: message)
+  end
+  before_down do |release|
+    #execute code before every rollback
+  end
+  after_down do |release|
+    #execute code after every rollback
+  end
+end)
+        create_file "config/clemency.rb", config_file
+      end
+    end
+  end
+end

data/lib/generators/clemency/release_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators/base'
+
+module Clemency
+  module Generators
+    class ReleaseGenerator < Rails::Generators::Base
+      argument :version, required: true
+
+      desc "Creates a new release file"
+      def create_release_file
+        release_file = %Q(Clemency.define_release do
+  set :version, "#{version}"
+  changelog do
+    #added "Added changelog item here..."
+    #changed "Changed changelog item here..."
+    #fixed "Fixed changelog item here..."
+  end
+  up do |release|
+    #perform release migration work here
+  end
+  down do |release|
+    #perform release rollback work here
+  end
+end)
+        create_file "releases/#{version}_release.rb", release_file
+        create_file ".version", "#{version}"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clemency
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Thomas Brewer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-22 00:00:00.000000000 Z
+date: 2019-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !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: Release management
 email:
 - tom@leftplusright.com
@@ -63,6 +77,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -70,7 +85,15 @@ files:
 - bin/setup
 - clemency.gemspec
 - lib/clemency.rb
+- lib/clemency/callbacks.rb
+- lib/clemency/changelog.rb
+- lib/clemency/configuration.rb
+- lib/clemency/railtie.rb
+- lib/clemency/release.rb
+- lib/clemency/tasks/clemency.rake
 - lib/clemency/version.rb
+- lib/generators/clemency/install_generator.rb
+- lib/generators/clemency/release_generator.rb
 homepage: https://github.com/leftplusrightllc/clemency
 licenses:
 - MIT