kamaze-version 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ed38b410f00dcebd12e53ee1c45dea6614c4270028394a30635192c9d6dea3d
+  data.tar.gz: c178c9e7fc4d18b17f9e48f9d573a026ebfe41e2d9b0d544e7d5bf61dce09ae6
+SHA512:
+  metadata.gz: 2ec693c1c924eaae1c988beb69f210e7f25d94aae12838fd0046277edbab7c9190c4d733729f72b099035da310b7e1563ed787b31b132002d26ceee10fc7d320
+  data.tar.gz: a1e4401d485d5a92b6cc62a953840c14b9da2582c1953a60132638082d6fa54b4ffc4ba4f6401acb64d760332821ffb6a0cd35c1893524a22c846bc26eaad6c0

data/.yardopts

@@ -0,0 +1,16 @@
+# vim: ft=sh
+
+lib/**/*.rb                                   \
+    --no-progress                             \
+    --markup-provider 'redcarpet'             \
+    --markup 'markdown'                       \
+    --charset 'utf-8'                         \
+    --protected --private --embed-mixins      \
+    --tag type:'type' --hide-tag 'type'       \
+    --readme README.md                        \
+    --exclude '_flymake\\.rb$'                \
+    --exclude '/\\.#'
+
+# Local Variables:
+# mode: sh
+# End:

data/lib/kamaze-version.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# License GPLv3+: GNU GPL version 3 or later
+# <http://www.gnu.org/licenses/gpl.html>.
+# This is free software: you are free to change and redistribute it.
+# There is NO WARRANTY, to the extent permitted by law.
+
+$LOAD_PATH.unshift(__dir__)
+
+lock = Dir.chdir("#{__dir__}/..") do
+  [['gems.rb', 'gems.locked'], ['Gemfile', 'Gemfile.lock']]
+    .map { |m| Dir.glob(m).size >= 2 }
+    .include?(true)
+end
+
+if lock
+  require 'rubygems'
+  require 'bundler/setup'
+
+  if Gem::Specification.find_all_by_name('kamaze-project').any?
+    require 'kamaze/project/core_ext/pp'
+  end
+end

data/lib/kamaze/version.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# License GPLv3+: GNU GPL version 3 or later
+# <http://www.gnu.org/licenses/gpl.html>.
+# This is free software: you are free to change and redistribute it.
+# There is NO WARRANTY, to the extent permitted by law.
+
+autoload :Pathname, 'pathname'
+autoload :Yaml, 'yaml'
+require 'dry/inflector'
+
+# rubocop:disable Style/Documentation
+
+module Kamaze
+  class Version
+    autoload :VERSION, "#{__dir__}/version/version"
+  end
+end
+
+# rubocop:enable Style/Documentation
+
+# Describe version using a YAML file.
+#
+# @see https://github.com/jcangas/version_info
+class Kamaze::Version
+  # Get filepath used to parse version (YAML file).
+  #
+  # @return [Pathname|String]
+  attr_reader :file
+
+  # @param [String|Pathname|nil] file
+  def initialize(file = nil)
+    (file.nil? ? file_from(caller_locations) : file).tap do |file|
+      @file = ::Pathname.new(file).freeze
+    end
+    parse!
+  end
+
+  # Denote version is semantically valid
+  #
+  # @return [Boolean]
+  def valid?
+    !!(/^([0-9]+\.){2}[0-9]+$/ =~ self.to_s)
+  rescue ::NameError
+    false
+  end
+
+  # @raise [NameError]
+  # @return [String]
+  def to_s
+    [major, minor, patch].map(&:to_i).join('.')
+  end
+
+  # @return [Hash]
+  def to_h
+    parsed.clone.freeze
+  end
+
+  # Return the path as a String.
+  #
+  # @see https://ruby-doc.org/stdlib-2.5.0/libdoc/pathname/rdoc/Pathname.html#method-i-to_path
+  # @return [String]
+  def to_path
+    file.to_s
+  end
+
+  protected
+
+  # Get parsed data
+  #
+  # @return [Hash]
+  attr_reader :parsed
+
+  # Get file automagically
+  #
+  # @param [Array] locations
+  # @return [Pathname]
+  def file_from(locations = caller_locations)
+    location = locations.first.path
+
+    Pathname.new(location).dirname.realpath.join('version.yml')
+  end
+
+  # Parse given file
+  #
+  # @param [Pathname] file
+  # @raise [Psych::DisallowedClass]
+  # @return [Hash]
+  def parse(file)
+    YAML.safe_load(file.read) || {}
+  rescue Errno::ENOENT
+    {}
+  end
+
+  # Parse and set attributes
+  #
+  # @return [self]
+  def parse!
+    @parsed = self.parse(self.file)
+                  .map { |k, v| self.attr_set(k, v) }
+                  .compact
+                  .to_h
+
+    self
+  end
+
+  # Define attribute (as ``ro`` attr) and set value.
+  #
+  # @param [String|Symbol] attr_name
+  # @param [Object] attr_value
+  # @return [Array|nil]
+  def attr_set(attr_name, attr_value)
+    attr_name = Dry::Inflector.new.underscore(attr_name.to_s)
+
+    return nil unless eligible_attr?(attr_name)
+
+    self.singleton_class.class_eval do
+      attr_accessor attr_name
+      # rubocop:disable Style/AccessModifierDeclarations
+      protected "#{attr_name}="
+      # rubocop:enable Style/AccessModifierDeclarations
+    end
+
+    self.__send__("#{attr_name}=", attr_value.freeze)
+
+    [attr_name, attr_value.freeze].freeze
+  end
+
+  # Denote given attr name is eligible (to be set)
+  #
+  # @param [String|Symbol] attr_name
+  # @return [Boolean]
+  def eligible_attr?(attr_name)
+    [attr_name, "#{attr_name}="].each do |v|
+      return false if self.respond_to?(v, true)
+    end
+
+    true
+  end
+end

data/lib/kamaze/version/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+# License GPLv3+: GNU GPL version 3 or later
+# <http://www.gnu.org/licenses/gpl.html>.
+# This is free software: you are free to change and redistribute it.
+# There is NO WARRANTY, to the extent permitted by law.
+
+require_relative '../version'
+
+class Kamaze::Version
+  VERSION = self.new.freeze
+end

data/lib/kamaze/version/version.yml

@@ -0,0 +1,17 @@
+---
+major: 1
+minor: 0
+patch: 0
+authors: ['Dimitri Arrigoni']
+email: 'dimitri@arrigoni.me'
+date: '2018-06-21'
+summary: 'Provide version as an object'
+description: 'Why use a simple String, when you can use an Object?'
+homepage: 'https://github.com/SwagDevOps/kamaze-version'
+licenses: ['GPL-3.0']
+license_header: |
+  Copyright (C) 2017-2018 Dimitri Arrigoni <dimitri@arrigoni.me>
+  License GPLv3+: GNU GPL version 3 or later
+  <http://www.gnu.org/licenses/gpl.html>.
+  This is free software: you are free to change and redistribute it.
+  There is NO WARRANTY, to the extent permitted by law.

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: kamaze-version
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dimitri Arrigoni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-inflector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Why use a simple String, when you can use an Object?
+email: dimitri@arrigoni.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- lib/kamaze-version.rb
+- lib/kamaze/version.rb
+- lib/kamaze/version/version.rb
+- lib/kamaze/version/version.yml
+homepage: https://github.com/SwagDevOps/kamaze-version
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Provide version as an object
+test_files: []