sycersion 0.1.0

data/lib/sycersion/version_environment.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'fileutils'
+
+module Sycersion
+  SYCERSION_DIR = '.sycersion'
+  SYCERSION_ENV = '.sycersion/environment.yml'
+  SYCERSION_VER = '.sycersion/version'
+
+  # Creates a version and a version file where the version is stored to.
+  class VersionEnvironment
+    attr_accessor :version
+
+    def initialize
+      return if load_environment
+
+      determine_version_and_version_file
+    end
+
+    def setup
+      puts "\nSetup the version environment"
+      puts "=============================\n"
+      prompt_version_and_version_file
+      create_environment
+      summary
+    end
+
+    def summary
+      summary_of_configuration
+      summary_of_environment
+    end
+
+    def summary_of_configuration
+      puts "\nYour configuration"
+      puts "------------------\n"
+      puts "\nVersion #{@version}"
+      puts "Version-file #{@version_file}\n"
+      puts create_code_snippet(@version_file)
+    end
+
+    def summary_of_environment
+      puts "\nWhere to find the configuration files"
+      puts "-------------------------------------\n"
+      puts "\nDirectory:          #{SYCERSION_DIR}"
+      puts "Configuration file: #{SYCERSION_ENV}\n"
+      puts "\nChange the configuration file only if you know what you are doing."
+      puts 'Otherwise run `sycersion --init` again.'
+    end
+
+    def determine_version_and_version_file
+      files = Dir.glob('**/*version*')
+      files.each do |file|
+        File.readlines(file, chomp: true).each do |line|
+          scan_result = line.scan(Sycersion::SEMVER_LAX_REGEX)
+          if scan_result[0]
+            @version_files[file] = [scan_result[0], line]
+            break
+          end
+        end
+      end
+    end
+
+    def prompt_version_and_version_file
+      if File.exist?(SYCERSION_VER)
+        resume_version_and_version_file
+      elsif @version_files.empty?
+        define_version_and_version_file
+      else
+        select_version_and_version_file
+      end
+    end
+
+    def resume_version_and_version_file
+      print "Current version-file #{@version_file}. To keep hit RETURN otherwise specify new: "
+      selection = gets.chomp
+      @version_file = selection.empty? ? @version_file : selection
+      print "Current version #{@version}. To keep hit RETURN otherwise enter new: "
+      selection = gets.chomp
+      @version = selection.empty? ? @version : selection
+    end
+
+    def define_version_and_version_file
+      puts 'No version and version-file found'
+      print "To use #{SYCERSION_VER} hit RETURN or specify own file: "
+      selection = gets.chomp
+      @version_file = selection.empty? ? SYCERSION_VER : selection
+      print 'To use `0.0.1` as initial version hit RETURN or specify own version: '
+      selection = gets.chomp.scan(Sycersion::SEMVER_REGEX)
+      @version = selection.empty? ? @version : selection
+      @version_string = @version
+    end
+
+    def select_version_and_version_file
+      puts "\nFound version-files\n"
+      puts "-------------------\n"
+      list_versions_and_version_files
+      print "\nChoose version-file and version with number or hit return for [0]: "
+      selection = gets.chomp.to_i
+      app_version_file = @version_files.keys[selection]
+      @version = Sycersion::Semver.version(@version_files[app_version_file][0])
+      @version_string = @version_files[@version_file[1]]
+    end
+
+    def list_versions_and_version_files
+      digits = digit_counter(@version_files)
+      filler = filler_string(' ', digits + 2)
+      @version_files.each_with_index do |entry, index|
+        choice = "[#{index.to_s.rjust(digits, ' ')}]"
+        print_line(choice, 'file:   ', entry[0])
+        print_line(filler, 'version:', Sycersion::Semver.version(entry[1][0]))
+        print_line(filler, 'line:   ', (entry[1][1]).strip)
+      end
+    end
+
+    def digit_counter(object)
+      object.size.to_s.length
+    end
+
+    def filler_string(fill_char, size)
+      fill_char * size
+    end
+
+    def print_line(prescriptor, descriptor, value)
+      puts "#{prescriptor} #{descriptor} #{value}"
+    end
+
+    def create_code_snippet(version_file)
+      <<-CODE_SNIP
+
+      In your application you can now access the version with
+
+      > File.read(#{version_file})
+
+      If you application framework has a defined place to assign
+      the version you could do like so
+
+      > version = File.read(#{version_file})
+      CODE_SNIP
+    end
+
+    def save
+      create_environment
+    end
+
+    def create_environment
+      FileUtils.mkdir(SYCERSION_DIR) unless Dir.exist?(SYCERSION_DIR)
+      File.open(@version_file, 'w') { |f| f.write(@version) }
+      File.open(SYCERSION_ENV, 'w') do |f|
+        YAML.dump([@version_file, @version], f)
+      end
+    rescue IOError => e
+      puts e.message
+    end
+
+    def load_environment
+      if File.exist?(SYCERSION_ENV)
+        @version_file, @version = YAML.load_file(SYCERSION_ENV)
+        true
+      else
+        @version_file = SYCERSION_VER
+        @version = '0.1.0'
+        @version_files = {}
+        @version_string = ''
+        false
+      end
+    end
+  end
+end

data/lib/sycersion/version_incrementer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Sycersion
+  NORMAL_REGEX = /^(\d+)\.(\d+)\.(\d+)/.freeze
+
+  # Increments the elements of a semantic version number major, minor, patch
+  class VersionIncrementer
+    def initialize
+      @environment = Sycersion::VersionEnvironment.new
+    end
+
+    def increment(position)
+      @environment.version = case position
+                             when :major
+                               increment_major
+                             when :minor
+                               increment_minor
+                             when :patch
+                               increment_patch
+                             end
+      @environment.save
+    end
+
+    def increment_major
+      "#{current_version[0].to_i + 1}.0.0"
+    end
+
+    def increment_minor
+      "#{current_version[0]}.#{current_version[1].to_i + 1}.0"
+    end
+
+    def increment_patch
+      "#{current_version[0]}.#{current_version[1]}.#{current_version[2].to_i + 1}"
+    end
+
+    def current_version
+      @environment.version.scan(NORMAL_REGEX).flatten
+    end
+  end
+end

data/lib/sycersion/version_info.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Managing the application's version according semver
+module Sycersion
+  # Provides information about the `sycersion` settings and the current version
+  class VersionInfo
+    def initialize
+      @environment = Sycersion::VersionEnvironment.new
+    end
+
+    def process(options)
+      case options[:info]
+      when :version
+        print @environment.version
+      when :summary
+        @environment.summary
+      end
+    end
+  end
+end

data/lib/sycersion/version_setter.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Sycersion
+  # Sets the version
+  class VersionSetter
+    def initialize
+      @environment = Sycersion::VersionEnvironment.new
+    end
+
+    # Sets the version provided by the version array. The version array is in
+    # the form ["version", "major", "minor", "patch", "pre-release", "build"]
+    def version=(version)
+      @environment.version = version[0]
+      @environment.save
+    end
+
+    # Sets the pre-release part only. The pre-release parameter is of the form
+    # ["pre-release", "pre-release"]
+    def pre_release=(pre_release)
+      create_version(3, pre_release[0])
+    end
+
+    # Sets the build part only. The build parameter is of the form
+    # ["build", "build"]
+    def build=(build)
+      create_version(4, build[0])
+    end
+
+    # Helper method for build= and pre_release=
+    def create_version(position, value)
+      version = @environment.version
+      semver_array = version.scan(Sycersion::SEMVER_REGEX).flatten
+      semver_array[position] = value
+      @environment.version = Sycersion::Semver.version(semver_array)
+      @environment.save
+    end
+  end
+end

data/lib/sycersion.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative 'sycersion/version'
+require_relative 'sycersion/options'
+require_relative 'sycersion/version_environment'
+require_relative 'sycersion/version_setter'
+require_relative 'sycersion/version_incrementer'
+require_relative 'sycersion/version_info'
+require_relative 'sycersion/version_compare'
+require_relative 'sycersion/semver'
+
+module Sycersion
+  class Error < StandardError; end
+
+  # Runs the program based on the arguments provided at the commandline
+  class Runner
+    def initialize(argv)
+      @options = Options.new(argv).options
+      pp @options if ENV['SYC_DEBUG']
+    end
+
+    def run
+      environment_settings
+      version_manipulation
+      version_compare
+      configuration_information
+    end
+
+    def environment_settings
+      Sycersion::VersionEnvironment.new.setup if @options[:init]
+    end
+
+    def version_manipulation
+      case @options.keys
+      when [:set]
+        Sycersion::VersionSetter.new.version = (@options[:set])
+      when [:pre_release]
+        Sycersion::VersionSetter.new.pre_release = (@options[:pre_release])
+      when [:build]
+        Sycersion::VersionSetter.new.build = (@options[:build])
+      when [:inc]
+        Sycersion::VersionIncrementer.new.increment(@options[:inc])
+      end
+    end
+
+    def version_compare
+      return unless @options[:compare]
+
+      @options[:compare].shift
+      puts Sycersion::VersionCompare.new.compare(@options[:compare])
+    end
+
+    def configuration_information
+      puts Sycersion::VersionInfo.new.process(@options) if @options[:info]
+    end
+  end
+end

data/man/sycersion.1

@@ -0,0 +1,184 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "SYCERSION" "1" "January 2025" "" ""
+.
+.SH "NAME"
+\fBsycersion\fR \- manage application versions according to semantic versioning
+.
+.SH "SYNOPSIS"
+.
+.nf
+
+`sycersion` `\-\-init`
+`sycersion` `\-i`|`\-\-info`
+`sycersion` `\-\-inc major|minor|patch`
+`sycersion` `\-\-set major\.minor\.patch[+build|\-pre\-release+build]`
+`sycersion` `\-p`|`\-\-pre` `pre\-release`
+`sycersion` `\-b`|`\-\-build` `build`
+`sycersion` `\-c`|`\-\-compare` `version`
+`sycersion` `\-h`|`\-\-help`
+.
+.fi
+.
+.SH "Description"
+\fBsycersion\fR is a command\-line tool to manage application versions following the guiding principles of \fIsemantic versioning\fR found at semver\.org \fIhttps://semver\.org\fR\.
+.
+.P
+\fBsycersion\fR has a default start version of 0\.1\.0\. This can be activitated with the initalization running \fBsycersion \-\-init\fR\. During this intialization another version can be chosen\. The version is saved to the \fIversion\-file\fR and also the \fIconfiguration\-directory\fR is created\. While initialization \fBsycersion\fR additionally searches for files that contain a version according to semantic versioning and the user can select out of the list of files which version out of that files to intially start with\.
+.
+.P
+The \fIversion\-file\fR and \fIconfiguration\-directory\fR are also created it the user is setting an initial version with \fBsycersion \-\-set 0\.1\.1\fR\.
+.
+.P
+If the version is updated the version is written into the \fIversion\-file\fR\. Within the application the version can be read from the file and displayed somewhere in the application\'s UI\.
+.
+.P
+\fBsycersion\fR evaluates version numbers provided that they comply to semantic versioning\.
+.
+.P
+If \fBsycersion\fR is used within a \fIRuby\fR application, it can be added to the development section within the Gemfile\.
+.
+.SH "FILES"
+.
+.nf
+
+`\.sycersion` is the configuration directory
+`\.sycersion/environment\.yml` holds the version file and the version
+`\.sycersion/version` contains the version
+.
+.fi
+.
+.SH "OPTIONS"
+.
+.IP "\(bu" 4
+\fB\-\-init\fR Initializes the \fBsycersion\fR environment with \fIversion\fR and \fIversion\-file\fR
+.
+.IP "\(bu" 4
+\fB\-i\fR, \fB\-\-info VERSION|SUMMARY\fR Shows the current \fIversion\fR (default) or additionally information about the \fIversion\-file\fR, the \fIconfiguration\-directory\fR and \fIcode\fR how to read the version within an application\.
+.
+.IP "\(bu" 4
+\fB\-\-inc MAJOR|MINOR|PATCH\fR increments the major, minor, patch part of the version\.
+.
+.IP "\(bu" 4
+\fB\-\-set MAJOR\.MINOR\.PATCH[+BUILD|\-PRE_RELEASE[+BUILD]]\fR sets the version where all three version parts need to be provided, major\.minor\.patch with optionally adding a pre\-release part and/or a build part\.
+.
+.IP "\(bu" 4
+\fB\-\-pre PRE\-RELEASE\fR Set the pre\-release part in the version
+.
+.IP "\(bu" 4
+\fB\-\-build BUILD\fR Set the build part in the version
+.
+.IP "\(bu" 4
+\fB\-c\fR, \fB\-\-compare VERSION\fR Compares the current version with the version provided following the semver precedence guidline
+.
+.IP "\(bu" 4
+\fB\-\-help\fR Prints the command line help
+.
+.IP "" 0
+.
+.SH "EXAMPLES"
+Initialize \fBsycersion\fR
+.
+.IP "" 4
+.
+.nf
+
+$ sycersion \-\-init
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Set the version with pre\-release
+.
+.IP "" 4
+.
+.nf
+
+$ sycersion \-\-set 0\.1\.1\-beta\.1\.0
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Set the version with a build
+.
+.IP "" 4
+.
+.nf
+
+$ sycersion \-\-set 0\.1\.1+build\-a\.1
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Set the version with a pre\-release and a build
+.
+.IP "" 4
+.
+.nf
+
+$ sycersion \-\-set 0\.1\.1\-beta\.1\.0+build\-a\.1
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Show the current version
+.
+.IP "" 4
+.
+.nf
+
+$ sycersion \-i
+0\.1\.1\-beta\.1\.0+build\-a\.1
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Increment minor part of the version 0\.1\.1, which will lead to 0\.2\.0
+.
+.IP "" 4
+.
+.nf
+
+$ sycersion \-\-inc minor
+$ sycersion \-i
+0\.2\.0
+.
+.fi
+.
+.IP "" 0
+.
+.P
+When increasing one of major, minor or patch, the subsequent numbers are eather reset to 0 or pre\-release and build are removed\.
+.
+.P
+Compare the assumed current version 0\.1\.1 to the provided version
+.
+.IP "" 4
+.
+.nf
+
+$ sycersion \-c 0\.1\.1\-alpha
+0\.1\.1 > 0\.1\.1\-alpha
+.
+.fi
+.
+.IP "" 0
+.
+.SH "ENVIRONMENT"
+.
+.IP "\(bu" 4
+SYC_DEBUG=true Will display erros and show contents of the parsed options\. To be called as \fBSYC_DEBUG=true sycersion [options]\fR
+.
+.IP "" 0
+