lapidario 0.2alpha.0 → 0.3alpha.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 721c005dc4e70e80f45c56f387ee66f6c8bbccecf06ca06349aa0ae362efd40f
-  data.tar.gz: 46f65d04260e78be7455b87545fecd6bcafb25b84aec9b4124a7808e84e0452e
+  metadata.gz: 20d6caf8e33b92cf05ac97c0aabbc067056c319c1f346f0b7dc18df4e15a53bc
+  data.tar.gz: f5523dcf45fea5d35c4a7fbb67bcf181d23b800cb56fb682a3f29a9929f14c71
 SHA512:
-  metadata.gz: c3ed33e86fded4875b8f3765b1a60954b3f9aca7ef1d81093e87f5895f2749e53e5f664daf0c2801a3b53d0d517001942d819d6f1d37a57fad1659812134f901
-  data.tar.gz: d5fa0f607b5db55ffc32817e2f84dcb25202ca681cb4da94f74e87f4c2da52c0cf0604e0096abb867201b5331cbd4c012fd423037b611e916507581fd821a31b
+  metadata.gz: 8ac1f42c2addf85814d1344a6cb0421cdd1484d2fb698ef13613897cda236a18ddc4966b6f2ad2649176b6bd79ec6cb19860792476c13feafa04a7e7684233be
+  data.tar.gz: 40f1b5d1889669bdb91949ef52aaab82b6f40e5c84cb8d35f2f683a4ed5a13ff36546ae5fa726433644362e55e2e7a4fe0c3d7a1f0230aca5228404d514996af

data/README.md

@@ -6,8 +6,9 @@ Welcome to your new gem! In this directory, you'll find the files you need to be
 
 ## TO DO:
 - [ ] Backup system: keep `Gemfile.original` stashed persistently
-- [ ] Add option to ignore Gemfile lines with `# LOCK` commented on their right
-- [ ] Normalize git gems with rubygems from Gemfile.lock
+- [x] Add option to ignore Gemfile lines with `# LOCK` commented to the right end of the line
+- [x] Normalize git gems with rubygems from Gemfile.lock
+- [x] Add logic to ignore any comments in Gemfile gem lines
 - [ ] Normalize gems from other sources with rubygems from Gemfile.lock
 
 ## Installation

data/lib/cli.rb

@@ -5,13 +5,35 @@ require_relative "lapidario"
 module Lapidario
   module CLI
     def self.start(_cmd_args)
+      if _cmd_args.include?('--help') || _cmd_args.include?('-h')
+        puts "Usage: lapidario [options]\n\n"
+        puts "NOTE: if you want to exclude any gem in your Gemfile to the functionality described below, comment 'LOCK' at the end of its line.\nSee examples:\n\n"
+        puts "Valid example of locking gem line:\n"
+        puts "gem 'rails', '~> 7.0' # LOCK"
+        puts "\n\nInvalid example of locking gem line:"
+        puts "gem 'rails', '~> 7.0' # Not locked, will be taken into account to rebuild Gemfile"
+        puts "\n\nOptions:"
+        puts "  --help, -h           Show help message"
+        puts "  --lock, -l           Rebuild Gemfile using versions specified in Gemfile.lock; default sign is '~>' and default depth is 2 (up to minor version, ignores patch)"
+        puts "  --reset, -r          Rebuild Gemfile without gem versions"
+        puts "  --full-reset, -fr    Rebuild Gemfile, removing all info but gem names"
+        exit
+      end
       puts "cmd args: #{_cmd_args}"
       project_path_hash = { project_path: './' }
       info_instances = Lapidario.get_gemfile_and_lockfile_info(project_path_hash)
       gemfile_info = info_instances[0]
       lockfile_info = info_instances[1]
       original_gemfile_lines = gemfile_info.original_gemfile
-      new_gemfile_info = Lapidario.hardcode_lockfile_versions_into_gemfile_info(gemfile_info, lockfile_info)
+      new_gemfile_info = case
+      when _cmd_args.include?('--reset'), _cmd_args.include?('-r')
+        Lapidario.hardcode_gemfile_with_empty_versions(gemfile_info, true) # keep_extra_info = true
+      when _cmd_args.include?('--full-reset'), _cmd_args.include?('-fr')
+        Lapidario.hardcode_gemfile_with_empty_versions(gemfile_info, false) # keep_extra_info = false
+      else # default = --lock
+        Lapidario.hardcode_lockfile_versions_into_gemfile_info(gemfile_info, lockfile_info)
+      end
+
       new_gemfile = Lapidario.build_new_gemfile(new_gemfile_info, original_gemfile_lines)
       puts "New gemfile created:"
       puts new_gemfile

data/lib/gemfile_info.rb

@@ -44,6 +44,8 @@ module Lapidario
 
     def self.gem_info(gemfile_line, line_index = -9999)
       gem_info = { line_index: line_index, name: "", prepended_spaces: 0, current_version: "", version_sign: "", extra_info: "" }
+      # ignore everything to the right of first '#' character
+      gemfile_line = gemfile_line.split("#", 2)[0]
       # count prepended spaces to reuse on gemfile rebuild
       gem_info[:prepended_spaces] = gemfile_line.match(/\A\s*/)[0].size
       # splits on coma, removes prepended whitespaces if any
@@ -76,7 +78,7 @@ module Lapidario
     # gi = gem_info
     def self.build_gemfile_line(gi)
       line = "#{' ' * gi[:prepended_spaces].to_i}gem '#{gi[:name]}'"
-      if gi[:current_version]
+      if gi[:current_version] && !gi[:current_version].empty?
         version_fragment = "#{gi[:current_version]}"
         version_fragment = "#{gi[:version_sign]} " + version_fragment if gi[:version_sign]
         line = line + ", '#{version_fragment}'"

data/lib/helper.rb

@@ -8,12 +8,19 @@ module Lapidario
     @@GEM_VERSION_FRAGMENT = /^\s*([<>]=?|~>)?\s*[0-9a-zA-Z\s.]+\s*$/
     @@DETECT_GEMFILE_IN_PATH = /\/Gemfile/
     @@DETECT_LOCKFILE_IN_PATH = /\/Gemfile\.lock/
+    # checks 0 or more spaces to the left or 1 or more to the right, also asserting that LOCK is at the end of string
+    @@DETECT_LOCKED_LINE = /\s*LOCK\s*\z/
 
     def self.version_fragment?(line_section)
       line_section.match? @@GEM_VERSION_FRAGMENT
     end
 
     def self.gem_line?(gemfile_line)
+      commented_portion = gemfile_line.split("#", 2)[1] # gets everything to the right of a '#' if present in line
+      if commented_portion && commented_portion.match?(@@DETECT_LOCKED_LINE)
+        puts "Ignoring line as it ends in # LOCK: \n#{gemfile_line}"
+        return false
+      end
       gemfile_line.match?(/^\s*gem\s+["']([^"']+)["']/)
     end
 

data/lib/lapidario/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lapidario
-  VERSION = "0.2alpha.0"
+  VERSION = "0.3alpha.0"
 end

data/lib/lapidario.rb

@@ -69,4 +69,17 @@ module Lapidario
     end
     new_gemfile_info
   end
+
+  # soft reset of gemfile, removing all version information. Removing extra info is optional
+  # Note: if a version is ranged and extra info is keps, this will also hard-code the version upper range in the gem line.
+  def self.hardcode_gemfile_with_empty_versions(gemfile_info, keep_extra_info = true)
+    new_gemfile_info = gemfile_info.gemfile_lines_info.clone
+    # replace versions in gemfile with ones on lockfile
+    new_gemfile_info.each do |gem_info|
+      gem_info[:current_version] = ""
+      gem_info[:version_sign] = ""
+      gem_info[:extra_info] = "" unless keep_extra_info
+    end
+    new_gemfile_info
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lapidario
 version: !ruby/object:Gem::Version
-  version: 0.2alpha.0
+  version: 0.3alpha.0
 platform: ruby
 authors:
 - octehren