incr 0.7.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beae18538716cd3443ecea4076ee9d05c0192c97cbbcf92e8c2b9e775b70bbf9
-  data.tar.gz: 8e02e3fe88c0b370bc48091efb75f15e0e288e8f11635bf7c036bc0d7b06ea81
+  metadata.gz: 0f794ed99e6baff884b2fdd079ae1334033be211256cd9503454be27370d9833
+  data.tar.gz: f1e68068b5466c44aad7203846cb25c009101282565debe53129e684a8c2dd22
 SHA512:
-  metadata.gz: 75ebb280db2da0b09bcbb9f0e73fb806f05386af61ac2d76b8c907a256576e024b99b97844ffbf5a5d42a68857f647f071a92b587bd8cc43815e86e461a53fd0
-  data.tar.gz: f1a1d70c6159aafbec950b02220a4af567675d8c270c7dfc973c2a1a6da498af6e2163ce40d1607452b2f712205b4eaa1bb058f893489b80821d8ff85d34a7b5
+  metadata.gz: aeb104c81ddd8ec4894a510bc848972cd96bb6e58ab4e533a61adec1de7dfa2c8dd86dc3d6a3ba89601c36a9ef994391223612040b72e7825691fd2b2c0269dd
+  data.tar.gz: ca773d11bc8758a98ead0cb9f43278f2c6923992c7ba9c33920aa68aa9bdbef1b473bc8e153a5592bb0d149215875747c6da8c3c9f0be8827179798e0e3713a1

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '**'
+
+permissions:
+  contents: read
+
+jobs:
+  ci:
+    runs-on: ubuntu-22.04
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: .tool-versions
+        bundler-cache: true
+    
+    - run: bundle exec rake

data/.github/workflows/gem-push.yml

@@ -0,0 +1,39 @@
+name: Publish RubyGem
+
+on: workflow_dispatch
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '2.7'
+        bundler-cache: true
+    
+    - run: bundle exec rake
+
+  publish:
+    runs-on: ubuntu-22.04
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '2.7'
+        bundler-cache: true
+
+    - run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+# To use the MeowCop gem.
+inherit_gem:
+  meowcop:
+    - config/rubocop.yml
+  
+AllCops:
+  NewCops: disable
+  SuggestExtensions: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/Gemfile.lock

@@ -1,23 +1,78 @@
 PATH
   remote: .
   specs:
-    incr (0.7.1)
-      git (= 1.3.0)
-      gli (= 2.17.1)
+    incr (1.0.0)
+      git (= 1.19.1)
+      gli (= 2.21.1)
       sem_version (= 2.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    git (1.3.0)
-    gli (2.17.1)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    diff-lcs (1.5.1)
+    git (1.19.1)
+      addressable (~> 2.8)
+      rchardet (~> 1.8)
+    gli (2.21.1)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    meowcop (3.2.0)
+      rubocop (>= 1.13.0, < 2.0.0)
+    parallel (1.24.0)
+    parser (3.3.1.0)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.5)
+    racc (1.8.0)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rchardet (1.8.0)
+    regexp_parser (2.9.2)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.63.5)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
     sem_version (2.0.1)
+    strscan (3.1.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   incr!
+  meowcop (= 3.2.0)
+  rake (= 13.2.1)
+  rspec (= 3.13.0)
+  rubocop (= 1.63.5)
 
 BUNDLED WITH
-   1.16.6
+   2.4.21

data/README.md

@@ -1,13 +1,11 @@
 <p align="center">
   <a href="https://github.com/jcouture/incr">
-    <img src="https://i.imgur.com/cHimJRm.png" alt="incr" />
+    <img src="https://user-images.githubusercontent.com/5007/160249855-dc0eb32f-f77d-4c5a-a995-93ac46408a68.png" alt="incr" />
   </a>
   <br />
-  Incr is a tool to help you easily increment the version number of your NPM or Mix packages.
+  incr is a tool to help you easily increment the version number of your NPM or Mix packages.
   <br /><br />
   <a href="https://rubygems.org/gems/incr"><img src="http://img.shields.io/gem/v/incr.svg" /></a>
-
-  <a href="https://travis-ci.org/jcouture/incr"><img src="http://img.shields.io/travis/jcouture/incr.svg" /></a>
 </p>
 
 ## What does `incr` do?
@@ -19,7 +17,7 @@ The process is detailed as follow:
 * Increment the specified segment. If you increment the minor segment, the patch segment is set to 0 and the same goes for the major segment, the minor and patch segments are set to 0.
 * Write the newly incremented version number in the relevant file(s).
 * Create a new `git commit` with the relevant file with the version number as the default message (e.g.: 0.2.1).
-* Create a new `git tag` pointing to the new `git commit` with the version number prefixed by a 'v' as the name (e.g.: v0.2.1).
+* Create a new annotated `git tag` pointing to the new `git commit` with the version number prefixed by a 'v' as the name (e.g.: v0.2.1).
 * 💥
 
 ## Installation
@@ -31,31 +29,38 @@ The process is detailed as follow:
 ```
 
 ## Usage
+
 To increment the patch segment of your NPM package version number:
+
 ```shell
 ~> incr npm patch
 ```
 
 To increment the minor segment of your Mix package version number:
+
 ```shell
 ~> incr mix minor
 ```
 
 ### Arguments
+
 Here are some arguments that can be used with `incr`:
+
 - `-d` : Directory where to search for the version files (default: `.`)
 - `-t` : Tag name pattern, where `%s` will be replaced with the new version (default: `v%s`)
 - `--[no-]commit` : Commit changes. (default: enabled)
 - `--[no-]tag` : Create a git tag. (default: enabled)
 
 Example:
+
 ```shell
-~> incr --no-tag -d ./subprojects/web/ -t MyCustomTagPrefix/%s npm patch
+~> incr --no-tag -d ./subprojects/web/ -t my-custom-tag-prefix/%s npm patch
 ```
 
 This will :
+
 - Search for `package.json` and `package-lock.json` files inside `./subprojects/web/` and update the patch version
-- Commit the changes under the message `MyCustomTagPrefix/2.3.4`
+- Commit the changes under the message `my-custom-tag-prefix/2.3.4`
 - Not create a tag with the new version
 
 ## Contributing
@@ -65,5 +70,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/jcoutu
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-The incr shield logo is based on [this icon](https://thenounproject.com/term/increment/621415/) by [blackspike](https://thenounproject.com/blackspike/), from the Noun Project. Used under a [Creative Commons BY 3.0](http://creativecommons.org/licenses/by/3.0/) license.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new(:rubocop)
+
+RSpec::Core::RakeTask.new(:test)
+
+task default: %i(rubocop test)

data/bin/incr

@@ -10,15 +10,15 @@ include GLI::App
 program_desc('Tasteful utility to increment the version number and create a corresponding git tag.')
 version(Incr::VERSION)
 
-flag [:d, :versionFileDirectory], :default_value => '.', :desc => 'Directory where to search for version file'
-flag [:t, :tagNamePattern], :default_value => 'v%s', :desc => 'Pattern for the tag name'
+flag([:d, :version_file_dir], default_value: '.', desc: 'Directory where to search for version file')
+flag([:t, :tag_name_pattern], default_value: 'v%s', desc: 'Pattern for the tag name')
 
-switch :commit, :default_value => true, :desc => 'Commit changes'
-switch :tag, :default_value => true, :desc => 'Create a git tag'
+switch(:commit, default_value: true, desc: 'Commit changes')
+switch(:tag, default_value: true, desc: 'Create a git tag')
 
 pre do |global, command, options, args|
   if args.length != 1 || !['major', 'minor', 'patch'].any? {|segment| args.include?(segment)}
-    STDERR.puts('Expecting a single argument: major, minor or patch.')
+    warn('expecting a single argument: major, minor or patch.')
     return false
   end
   true
@@ -42,4 +42,13 @@ command :mix do |cmd|
   end
 end
 
+# Laravel Support
+desc('Increment the version of your config/app.php.')
+command :laravel do |cmd|
+  cmd.action do |global_options, options, args|
+    mix = Incr::Command::Laravel.new(args, global_options)
+    mix.execute
+  end
+end
+
 exit(run(ARGV))

data/incr.gemspec

@@ -18,7 +18,14 @@ Gem::Specification.new do |spec|
   spec.executables << 'incr'
   spec.require_paths << 'lib'
 
-  spec.add_runtime_dependency('gli', '2.17.1')
+  spec.required_ruby_version = '>= 3.2'
+
+  spec.add_runtime_dependency('gli', '2.21.1')
   spec.add_runtime_dependency('sem_version', '2.0.1')
-  spec.add_runtime_dependency('git', '1.3.0')
+  spec.add_runtime_dependency('git', '1.19.1')
+
+  spec.add_development_dependency('rake', '13.2.1')
+  spec.add_development_dependency('rspec', '3.13.0')
+  spec.add_development_dependency('rubocop', '1.63.5')
+  spec.add_development_dependency('meowcop', '3.2.0')
 end

data/lib/incr/command/laravel.rb

@@ -0,0 +1,58 @@
+module Incr
+  module Command
+    class Laravel
+      VERSION_REGEX = /'version' => '(\d*.\d*.\d*)'/
+      VERSION_REPLACEMENT_PATTERNS = [
+        "'version' => '%s",
+      ]
+
+      def initialize(args, global_options)
+        @segment = args[0]
+        @config_file_filename = File.join('.', global_options[:version_file_dir], 'config', 'app.php')
+        @tag_pattern = global_options[:tag_name_pattern]
+        @commit = global_options[:commit]
+        @tag = global_options[:tag]
+        @noop = global_options[:noop]
+      end
+
+      def execute
+        if !File.exist?(@config_file_filename)
+          warn("'#{@config_file_filename}': file not found.")
+          return
+        end
+
+        file_content = IO.read(@config_file_filename)
+        if file_content == nil
+          return
+        end
+
+        file_version = file_content.match(VERSION_REGEX)[1]
+        old_version = SemVersion.new(file_version)
+        new_version = Incr::Service::Version.increment_segment(old_version, @segment)
+        replace_file_version(old_version, new_version)
+
+        new_tag = @tag_pattern % new_version.to_s
+
+        puts new_tag
+
+        if not @noop
+          repository = Incr::Service::Repository.new('.')
+          repository.add(@config_file_filename)
+          repository.commit(new_tag) if @commit
+          repository.tag(new_tag) if @tag
+        end
+      end
+
+      private
+
+      def replace_file_version(old_version, new_version)
+        VERSION_REPLACEMENT_PATTERNS.each do |pattern|
+          old_version_pattern = format(pattern, old_version.to_s)
+          new_version_pattern = format(pattern, new_version.to_s)
+
+          Incr::Service::FileHelper.replace(@config_file_filename, old_version_pattern, new_version_pattern)
+        end
+      end
+    end
+  end
+end

data/lib/incr/command/mix.rb

@@ -9,14 +9,20 @@ module Incr
 
       def initialize(args, global_options)
         @segment = args[0]
-        @mix_file_filename = File.join('.', global_options[:versionFileDirectory], 'mix.exs')
-        @tag_pattern = global_options[:tagNamePattern]
+        @mix_file_filename = File.join('.', global_options[:version_file_dir], 'mix.exs')
+        @tag_pattern = global_options[:tag_name_pattern]
         @commit = global_options[:commit]
         @tag = global_options[:tag]
+        @noop = global_options[:noop]
       end
 
       def execute
-        file_content = parse_content(@mix_file_filename)
+        if !File.exist?(@mix_file_filename)
+          warn("'#{@mix_file_filename}': file not found.")
+          return
+        end
+
+        file_content = IO.read(@mix_file_filename)
         if file_content == nil
           return
         end
@@ -30,29 +36,22 @@ module Incr
 
         puts new_tag
 
-        repository = Incr::Service::Repository.new('.')
-        repository.add(@mix_file_filename)
-        repository.commit(new_tag) if @commit
-        repository.tag(new_tag) if @tag
+        if not @noop
+          repository = Incr::Service::Repository.new('.')
+          repository.add(@mix_file_filename)
+          repository.commit(new_tag) if @commit
+          repository.tag(new_tag) if @tag
+        end
       end
 
       private
 
-      def parse_content(filename)
-        if !File.exist?(filename)
-          STDERR.puts("[Err] '#{filename}' not found.")
-          return nil
-        end
-
-        IO.read(filename)
-      end
-
       def replace_file_version(old_version, new_version)
         VERSION_REPLACEMENT_PATTERNS.each do |pattern|
           old_version_pattern = format(pattern, old_version.to_s)
           new_version_pattern = format(pattern, new_version.to_s)
 
-          Incr::Service::FileHelper.replace_string_once(@mix_file_filename, old_version_pattern, new_version_pattern)
+          Incr::Service::FileHelper.replace(@mix_file_filename, old_version_pattern, new_version_pattern)
         end
       end
     end

data/lib/incr/command/npm.rb

@@ -16,15 +16,26 @@ module Incr
       def initialize(args, global_options)
         @segment = args[0]
 
-        @package_json_filename = File.join('.', global_options[:versionFileDirectory], 'package.json')
-        @package_json_lock_filename = File.join('.', global_options[:versionFileDirectory], 'package-lock.json')
-        @tag_pattern = global_options[:tagNamePattern]
+        @package_json_filename = File.join('.', global_options[:version_file_dir], 'package.json')
+        @package_json_lock_filename = File.join('.', global_options[:version_file_dir], 'package-lock.json')
+        @tag_pattern = global_options[:tag_name_pattern]
         @commit = global_options[:commit]
         @tag = global_options[:tag]
+        @noop = global_options[:noop]
       end
 
       def execute
-        package_json = parse_content(@package_json_filename)
+        if !File.exist?(@package_json_filename)
+          warn("'#{@package_json_filename}': file not found.")
+          return
+        end
+
+        if !File.exist?(@package_json_lock_filename)
+          warn("'#{@package_json_lock_filename}': file not found.")
+          return
+        end
+
+        package_json = JSON.parse(IO.read(@package_json_filename))
         if package_json == nil
           return
         end
@@ -40,28 +51,21 @@ module Incr
 
         puts new_tag
 
-        repository = Incr::Service::Repository.new('.')
-        repository.add(@package_json_filename)
-        repository.add(@package_json_lock_filename)
-        repository.commit(new_tag) if @commit
-        repository.tag(new_tag) if @tag
+        if not @noop
+          repository = Incr::Service::Repository.new('.')
+          repository.add(@package_json_filename)
+          repository.add(@package_json_lock_filename)
+          repository.commit(new_tag) if @commit
+          repository.tag(new_tag) if @tag
+        end
       end
 
       private
 
-      def parse_content(filename)
-        if !File.exist?(filename)
-          STDERR.puts("[Err] '#{filename}' not found.")
-          return nil
-        end
-
-        JSON.parse(IO.read(filename))
-      end
-
       def replace_file_version(filename, new_version)
         LOOKBEHIND_PATTERNS.each do |lookbehind_pattern|
           pattern = /#{lookbehind_pattern}#{VERSION_PATTERN}/
-          Incr::Service::FileHelper.replace_regexp_once(filename, pattern, new_version)
+          Incr::Service::FileHelper.replace(filename, pattern, new_version)
         end
       end
     end

data/lib/incr/service/file_helper.rb

@@ -1,11 +1,7 @@
 module Incr
   module Service
     class FileHelper
-      def self.replace_string_once(filename, old_text, new_text)
-        replace_regexp_once(filename, /#{Regexp.escape(old_text)}/, new_text)
-      end
-
-      def self.replace_regexp_once(filename, pattern, replacement_text)
+      def self.replace(filename, pattern, replacement_text)
         old_content = File.read(filename)
         new_content = old_content.sub(pattern, replacement_text)
         File.open(filename, 'w') { |file| file << new_content }

data/lib/incr/service/repository.rb

@@ -16,7 +16,7 @@ module Incr
       end
 
       def tag(name)
-        @git.add_tag(name)
+        @git.add_tag(name, annotate: true, message: name)
       end
     end
   end

data/lib/incr/version.rb

@@ -1,3 +1,3 @@
 module Incr
-  VERSION = '0.7.1'
+  VERSION = '1.1.0'
 end

data/lib/incr.rb

@@ -3,4 +3,5 @@ require 'incr/service/version'
 require 'incr/service/file_helper'
 require 'incr/command/npm'
 require 'incr/command/mix'
+require 'incr/command/laravel'
 require 'incr/version'

data/spec/fixtures/laravel/app.php

@@ -0,0 +1,6 @@
+<?php
+
+return [
+	'name' => env('APP_NAME', 'Laravel'),
+	'version' => '1.0.0',
+]

data/spec/fixtures/mix/mix.exs

@@ -0,0 +1,30 @@
+defmodule Foobar.MixProject do
+  use Mix.Project
+
+  @version "1.0.0"
+
+  def project do
+    [
+      app: :foobar,
+      version: @version,
+      elixir: "~> 1.13",
+      start_permanent: Mix.env() == :prod,
+      deps: deps()
+    ]
+  end
+
+  # Run "mix help compile.app" to learn about applications.
+  def application do
+    [
+      extra_applications: [:logger]
+    ]
+  end
+
+  # Run "mix help deps" to learn about dependencies.
+  defp deps do
+    [
+      # {:dep_from_hexpm, "~> 0.3.0"},
+      # {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"}
+    ]
+  end
+end

data/spec/fixtures/npmv6/package-lock.json

@@ -0,0 +1,13 @@
+{
+  "name": "foobar",
+  "version": "7.0.0",
+  "lockfileVersion": 1,
+  "requires": true,
+  "dependencies": {
+    "is-number": {
+      "version": "7.0.0",
+      "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
+      "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng=="
+    }
+  }
+}

data/spec/fixtures/npmv6/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "foobar",
+  "version": "7.0.0",
+  "dependencies": {
+    "is-number": "^7.0.0"
+  }
+}

data/spec/fixtures/npmv7/package-lock.json

@@ -0,0 +1,30 @@
+{
+  "name": "foobar",
+  "version": "7.0.0",
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "foobar",
+      "version": "7.0.0",
+      "dependencies": {
+        "is-number": "^7.0.0"
+      }
+    },
+    "node_modules/is-number": {
+      "version": "7.0.0",
+      "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
+      "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==",
+      "engines": {
+        "node": ">=0.12.0"
+      }
+    }
+  },
+  "dependencies": {
+    "is-number": {
+      "version": "7.0.0",
+      "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
+      "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng=="
+    }
+  }
+}

data/spec/fixtures/npmv7/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "foobar",
+  "version": "7.0.0",
+  "dependencies": {
+    "is-number": "^7.0.0"
+  }
+}