semantic_release 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 229b0a68dcb2758c59ea49303e7f5e4dd3320da5f96662f9475ea9cefae093e4
+  data.tar.gz: 2e05b0c685a867b4612cf4d47a58cd861c4dc1d276e31064c297ccbea90674e9
+SHA512:
+  metadata.gz: 6cef35b65b374159ae329ebc38c524c81158c0835a722da271343031d9abc006e4944c26e7ad0cabcd7ffc433db92cb003b766e69bcd333841546db3282d07d5
+  data.tar.gz: 3fbfc6a1ccad7ee107316ed6b6825403eb716a42e1e97cc49f2eeaf21ca93bcb194cdb2961af14dc3471e7e97568e59822ff161d302c9785e2c6700cfa14b5dd

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,19 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Layout/LineContinuationLeadingSpace:
+  EnforcedStyle: leading
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1 @@
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 David Bull
+
+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,69 @@
+# SemanticRelease
+
+This gem helps you to manage the version number of your application or library.
+
+Use the provided Rake tasks to:
+
+- bump the major, minor, or patch number of your version
+- automatically update our verison file (e.g. `lib/version.rb`)
+- automatically update your changelog (`CHANGELOG.md` or `history.rdoc`)
+- automatically create a git commit and tag for the release
+
+This gem was inspired by:
+
+- SemVer2 (https://github.com/haf/semver)
+- Rake-n-Bake (https://github.com/RichardVickerstaff/rake-n-bake)
+- Version Manager (https://github.com/tpbowden/version_manager)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add semantic_release
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install semantic_release
+```
+
+## Usage
+
+Add the Rake task by adding the following lines to a Rake configuration file (e.g. `Rakefile` or `lib/tasks/default.rake`):
+
+```ruby
+require "semantic_release/rake_task"
+SemanticRelease::RakeTask.new
+```
+
+The following tasks are available:
+
+```
+rake semantic_release:init
+rake semantic_release:current
+rake semantic_release:major
+rake semantic_release:minor
+rake semantic_release:patch
+```
+
+To get the current version inside your application:
+
+```ruby
+SemanticRelease.current_version
+```
+
+## 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 the created tag, 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/ukdave/semantic_release.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+require_relative "lib/semantic_release/rake_task"
+SemanticRelease::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/semantic_release/rake_task.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "rake/tasklib"
+require "semantic_release"
+
+module SemanticRelease
+  class RakeTask < Rake::TaskLib
+    # rubocop:disable Metrics/MethodLength
+    def initialize
+      super
+
+      namespace :semantic_release do
+        desc "Initialise version file"
+        task :init do
+          SemanticRelease.init
+        end
+
+        desc "Display current version"
+        task :current do
+          puts SemanticRelease.current_version
+        end
+
+        desc "Increment major version (e.g. 1.2.3 => 2.0.0)"
+        task :major do
+          SemanticRelease.inc_major
+        end
+
+        desc "Increment minor version (e.g. 1.2.3 => 1.3.0)"
+        task :minor do
+          SemanticRelease.inc_minor
+        end
+
+        desc "Increment patch version (e.g. 1.2.3 => 1.2.4)"
+        task :patch do
+          SemanticRelease.inc_patch
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/semantic_release/semver.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "json"
+
+module SemanticRelease
+  class Semver
+    include Comparable
+
+    attr_reader :major, :minor, :patch
+
+    def initialize(major: 0, minor: 0, patch: 0, file: nil)
+      @major = major
+      @minor = minor
+      @patch = patch
+      @file = file
+    end
+
+    def self.load(file)
+      data = JSON.parse(File.read(file))
+      new(major: data["major"], minor: data["minor"], patch: data["patch"], file: file)
+    end
+
+    def save(file = nil)
+      f = file || @file
+      File.write(f, JSON.generate(to_h))
+    end
+
+    def increment(term)
+      case term.to_sym
+      when :major then increment_major
+      when :minor then increment_minor
+      when :patch then increment_patch
+      else raise ArgumentError, "Bad term"
+      end
+      self
+    end
+
+    def increment_major
+      @major += 1
+      @minor = 0
+      @patch = 0
+    end
+
+    def increment_minor
+      @minor += 1
+      @patch = 0
+    end
+
+    def increment_patch
+      @patch += 1
+    end
+
+    def to_s
+      [@major, @minor, @patch].join(".")
+    end
+
+    def to_h
+      { major: @major, minor: @minor, patch: @patch }
+    end
+
+    def <=>(other)
+      %i[major minor patch].each do |method|
+        comparison = (send(method) <=> other.send(method))
+        return comparison unless comparison.zero?
+      end
+      0
+    end
+  end
+end

data/lib/semantic_release/updaters/base_updater.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SemanticRelease
+  module Updaters
+    class BaseUpdater
+      def self.update
+        raise "Not implemented"
+      end
+
+      def self.current_version
+        Semver.load(semver_file).to_s
+      end
+
+      def self.semver_file
+        SemanticRelease::SEMVER_FILE
+      end
+    end
+  end
+end

data/lib/semantic_release/updaters/changelog.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SemanticRelease
+  module Updaters
+    class Changelog < BaseUpdater
+      FILES = %w[CHANGELOG.md history.rdoc].freeze
+
+      def self.update
+        FILES.each do |file|
+          next unless File.exist?(file)
+
+          prepend_version(file)
+          `git add #{file}`
+        end
+      end
+
+      def self.prepend_version(filepath)
+        heading_marker = filepath.end_with?(".rdoc") ? "==" : "##"
+        content = File.read(filepath)
+        File.open(filepath, "w") do |f|
+          f.puts("#{heading_marker} #{current_version} (#{Time.now.strftime("%d %B %Y")})\n")
+          f.print(content)
+        end
+      end
+    end
+  end
+end

data/lib/semantic_release/updaters/git_tag.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SemanticRelease
+  module Updaters
+    class GitTag < BaseUpdater
+      def self.update
+        tag = "v#{current_version}"
+        msg = "Increment version to v#{current_version}"
+
+        `git add #{semver_file} && git commit -m '#{msg}' && git tag #{tag} -a -m '#{Time.now}'`
+
+        branch = `git rev-parse --abbrev-ref HEAD`.chomp
+        puts "To push the new tag, use 'git push origin #{branch} --tags'"
+      end
+    end
+  end
+end

data/lib/semantic_release/updaters/version_rb.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SemanticRelease
+  module Updaters
+    class VersionRb < BaseUpdater
+      def self.update
+        version_file = find_version_rb
+        return unless version_file
+
+        version_string = "VERSION = \"#{current_version}\""
+        content = File.read(version_file).sub(/VERSION = .*$/, version_string)
+
+        File.write(version_file, content)
+        `git add #{version_file}`
+      end
+
+      def self.find_version_rb
+        version_files = Dir.glob("lib{,/**/*}/version.rb")
+        return nil unless version_files.size == 1
+
+        version_files.first
+      end
+    end
+  end
+end

data/lib/semantic_release/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SemanticRelease
+  VERSION = "0.1.0"
+end

data/lib/semantic_release.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "semantic_release/semver"
+require_relative "semantic_release/version"
+Dir[File.join(__dir__, "semantic_release", "updaters", "*.rb")].each { |file| require file }
+
+module SemanticRelease
+  class Error < StandardError; end
+
+  SEMVER_FILE = ".semver"
+
+  def self.init
+    version = Semver.new
+    version.save(SEMVER_FILE)
+  end
+
+  def self.current_version
+    Semver.load(SEMVER_FILE).to_s
+  end
+
+  def self.inc_major
+    increment(:major)
+    release
+  end
+
+  def self.inc_minor
+    increment(:minor)
+    release
+  end
+
+  def self.inc_patch
+    increment(:patch)
+    release
+  end
+
+  def self.increment(term)
+    version = Semver.load(SEMVER_FILE)
+    version.increment(term)
+    version.save
+  end
+
+  def self.release
+    Updaters::Changelog.update
+    Updaters::VersionRb.update
+    Updaters::GitTag.update
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: semantic_release
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Bull
+bindir: exe
+cert_chain: []
+date: 2025-02-02 00:00:00.000000000 Z
+dependencies: []
+description: |
+  This gem helps you to manage the version number of your application or library. It provides Rake tasks to
+  automatically update your version file, changelog file, and create a git tag.
+email:
+- david@uk-dave.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/semantic_release.rb
+- lib/semantic_release/rake_task.rb
+- lib/semantic_release/semver.rb
+- lib/semantic_release/updaters/base_updater.rb
+- lib/semantic_release/updaters/changelog.rb
+- lib/semantic_release/updaters/git_tag.rb
+- lib/semantic_release/updaters/version_rb.rb
+- lib/semantic_release/version.rb
+homepage: https://github.com/ukdave/semantic_release
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ukdave/semantic_release
+  source_code_uri: https://github.com/ukdave/semantic_release
+  changelog_uri: https://github.com/ukdave/semantic_release/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Rake tasks to help you to manage your version number and releases
+test_files: []