lapidario 0.3alpha.0 → 0.3beta.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20d6caf8e33b92cf05ac97c0aabbc067056c319c1f346f0b7dc18df4e15a53bc
-  data.tar.gz: f5523dcf45fea5d35c4a7fbb67bcf181d23b800cb56fb682a3f29a9929f14c71
+  metadata.gz: 41f5cc564d0ff9a994570ecb899125c0dbf719aefa1de77c5a011f79c6cdb3a5
+  data.tar.gz: c5d4c5b3844a346b1aa55b4aca8feaf4d58cbee443f5b1f19ad60ed9a2472ebb
 SHA512:
-  metadata.gz: 8ac1f42c2addf85814d1344a6cb0421cdd1484d2fb698ef13613897cda236a18ddc4966b6f2ad2649176b6bd79ec6cb19860792476c13feafa04a7e7684233be
-  data.tar.gz: 40f1b5d1889669bdb91949ef52aaab82b6f40e5c84cb8d35f2f683a4ed5a13ff36546ae5fa726433644362e55e2e7a4fe0c3d7a1f0230aca5228404d514996af
+  metadata.gz: 5d8a1c25939106175845ab619a80568426054d68cc6dc20b545c07992a1b6e7e6b9c2845f4035aa085feb02b2a36a6809fd56888a4404348c9f93fa0b114655c
+  data.tar.gz: 57d50d3eeedef2f863e8e105e1dc300c08c0ec0cbfc5c5dd75a210b681c3786a53eebf9f9b6ec7b921db375dda128a29d233ab1a098dfa9411e86c2823795764

data/Gemfile

@@ -1,16 +1,2 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in lapidario.gemspec
-gemspec
-
-group :development, :test do
-  gem "pry", "~> 0.14", require: true
-
-  gem "rake", "~> 13.0"
-
-  gem "rspec", "~> 3.0"
-
-  gem "rubocop", "~> 1.21"
-end
+gem "rails", "6.0.0"
+gem "rspec", "3.10.0"

data/README.md

@@ -1,41 +1,46 @@
 # Lapidario
+'Lapidario' is a noun that is derived from the Latin 'lapidarius,' which means "of or relating to engraved stones or inscriptions." It can also mean "one who engraves stones or inscriptions".
+It is also a Gemfile and Gemfile.lock static analyzer made to help with edition and management of Gemfiles.
+The idea for it was conceived while upgrading gem versions for a lot of Rails microservices at once.
+Its main use is to make a Gemfile better reflect the current state of versions used in a project, and also to specify or maintain explicit gem versions in order to better avoid [dependency hell](https://en.wikipedia.org/wiki/Dependency_hell).
 
-TODO: Delete this and the text below, and describe your gem
+# Example Workflow #1 : Updating Most Gems
+Let's suppose you have a project that has not been updated in a while. You would like to update every gem version in your gemfile except for, say, RSpec.
+<add # LOCK to the right of rspec, run lapidario reset, run bundle >
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/lapidario`. To experiment with that code, run `bin/console` for an interactive prompt.
+# Example Workflow #2 : Performing a Minor Update
 
-## TO DO:
-- [ ] Backup system: keep `Gemfile.original` stashed persistently
-- [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
 
 TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
 
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
+Install lts version:
+`gem install lapidario`
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+Install pre-release version:
+`gem install lapidario --pre`
 
 ## Usage
 
 TODO: Write usage instructions here
 
+## TO DO:
+- [x] Backup system: keep `Gemfile.original` stashed persistently
+- [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 (such as GIT) with rubygems from Gemfile.lock
+
 ## 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.
+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. Run `bin/lapidario` to test changes in CLI integration.
 
 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/[USERNAME]/lapidario.
+Bug reports and pull requests are welcome on GitHub at https://github.com/octehren/lapidario.
 
 ## License
 

data/bin/lapidario

@@ -3,4 +3,4 @@
 
 require_relative "../lib/cli"
 
-Lapidario::CLI.start(ARGV)
+Lapidario::CLI.new(ARGV).start

data/lapidario.gemspec

@@ -9,15 +9,15 @@ Gem::Specification.new do |spec|
   spec.email = ["ehren.dev.mail@gmail.com"]
 
   spec.summary = "Auxiliary for bulk updates of gems in a project."
-  spec.description = "Lapidario is a Gemfile and Gemfile.lock static analyzer that helps with bulk updates of gems in a project. As of version 0.1, run it in a directory with both a Gemfile and Gemfile.lock to hard-code the locked versions in Gemfile.lock to the Gemfile."
-  spec.homepage = "https://example.com"
+  spec.description = "Lapidario is a Gemfile and Gemfile.lock static analyzer that helps with bulk updates and explicit version hard-coding of gems in a project. See https://github.com/octehren/lapidario for more."
+  spec.homepage = "https://github.com/octehren/lapidario"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://example.com"
+  spec.metadata["source_code_uri"] = "https://github.com/octehren/lapidario"
   spec.metadata["changelog_uri"] = "https://example.com" # Put your gem's CHANGELOG.md URL here.
 
   # Specify which files should be added to the gem when it is released.

data/lib/cli.rb

@@ -3,41 +3,100 @@ require "optparse"
 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
+  class CLI
+    def initialize(_cmd_args)
+      parse_options(_cmd_args) # will initialize variables below if options are passed
+      @project_path_hash ||= { project_path: './' }
+      @reset_gemfile ||= false
+      @full_reset_gemfile ||= false
+      @lock_gemfile ||= true unless @reset_gemfile || @full_reset_gemfile
+      @version_depth ||= 2
+      @version_sign ||= '~>'
+      @save_new_gemfile ||= false
+      @save_backup ||= true if @save_backup.nil? # conditional assignment also executes on non-nil falsey values
+    end
+
+    def parse_options(options)
+      opt_parser = OptionParser.new do |opts|
+        opts.on("-h", "--help", "Show help message") do
+          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 "\nInvalid example of locking gem line:"
+          puts "gem 'rails', '~> 7.0' # Not locked, will be taken into account to rebuild Gemfile\n\n"
+          puts opts
+          exit
+        end
+
+        opts.on("-w", "--write", "Writes command output to Gemfile. Backs up previous Gemfile in Gemfile.original, remember to remove it later") do
+          @save_new_gemfile = true
+        end
+
+        opts.on("-s", "--skip-backup", "Skips creation of backup Gemfile.original if writing to Gemfile") do
+          @save_backup = false
+        end
+
+        opts.on("-d", "--depth NUMBER", "Select depth (major = 1, minor = 2, patch = 3) of version string; min = 1, max = 3, default = 2") do |depth|
+          @version_depth = depth.to_i
+        end
+
+        opts.on("-v", "--version-sign NUMBER", "Select sign to use for version specification (default = '~>') (0 = '~>', 1 = '>=', 2 = '<=', 3 = '>', 4 = '<', 5 = no sign)") do |sign|
+          @version_sign = Lapidario::Helper.get_version_sign_from_number(sign.to_i)
+        end
+
+        opts.on("-p", "--path STRING", "Define path in which Gemfile and Lockfile are located. Defaults to current directory") do |project_path|
+          @project_path_hash = { project_path: project_path }
+        end
+
+        opts.on("-l", "--lock", "Rebuild Gemfile using versions specified in Gemfile.lock; default sign is '~>' and default depth is 2 (major & minor versions, ignores patch)") do
+          @lock_gemfile = true
+        end
+
+        opts.on("-r", "--reset", "Rebuild Gemfile without gem versions") do
+          @reset_gemfile = true
+        end
+
+        opts.on("-f", "--full-reset", "Rebuild Gemfile, removing all info but gem names") do
+          @full_reset_gemfile = true
+        end
       end
-      puts "cmd args: #{_cmd_args}"
-      project_path_hash = { project_path: './' }
-      info_instances = Lapidario.get_gemfile_and_lockfile_info(project_path_hash)
+
+      # Parse the command-line arguments
+      opt_parser.parse!(options)
+    end
+
+    def start
+      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 = 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
+        when @reset_gemfile
+          Lapidario.hardcode_gemfile_with_empty_versions(gemfile_info, true) # keep_extra_info = true
+        when @full_reset_gemfile
+          Lapidario.hardcode_gemfile_with_empty_versions(gemfile_info, false) # keep_extra_info = false
+        when @lock_gemfile # default = --lock
+          Lapidario.hardcode_lockfile_versions_into_gemfile_info(gemfile_info, lockfile_info, @version_sign, @version_depth)
+        end
 
       new_gemfile = Lapidario.build_new_gemfile(new_gemfile_info, original_gemfile_lines)
-      puts "New gemfile created:"
+      puts "New gemfile created:\n\n================================== GEMFILE START =================================="
       puts new_gemfile
-      puts "In case it does not look right, check for Gemfile.original in the same directory."
+      puts "================================== GEMFILE END ==================================\n\nIn case it does not look right, check for Gemfile.original in the same directory if you are writing to the Gemfile and did not cancel the backup."
+      if @save_new_gemfile
+        begin
+          save_path = Lapidario::Helper.format_path(@project_path_hash[:project_path], false)
+          Lapidario::Helper.save_file(save_path, new_gemfile.join("\n"))
+          if @save_backup
+            Lapidario::Helper.save_file(save_path + ".original", original_gemfile_lines.join("\n")) 
+            puts "\n\nSaved backup to #{save_path}.original\n\n"
+          end
+        rescue => e
+          puts "Failed to save file: #{e.message}"
+          raise e
+        end
+        puts "Saved new Gemfile to #{save_path}"
+      end
     end
   end
 end

data/lib/gemfile_info.rb

@@ -81,7 +81,7 @@ module Lapidario
       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}'"
+        line = line + ", '#{version_fragment.strip}'"
       end
       line = line + ", #{gi[:extra_info]}" if gi[:extra_info] && !gi[:extra_info].empty?
       line

data/lib/helper.rb

@@ -10,6 +10,7 @@ module Lapidario
     @@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/
+    @@VERSION_SIGNS = ['~>', '>=', '<=', '>', '<', '']
 
     def self.version_fragment?(line_section)
       line_section.match? @@GEM_VERSION_FRAGMENT
@@ -24,6 +25,11 @@ module Lapidario
       gemfile_line.match?(/^\s*gem\s+["']([^"']+)["']/)
     end
 
+    def self.get_version_sign_from_number(version_sign_num)
+      raise "Available version signs range from 0 to 5, run `$lapidario --help` for details" if version_sign_num > 5 || version_sign_num < 0
+      @@VERSION_SIGNS[version_sign_num]
+    end
+
     # formats based on depth; ex: version_fragment = '3.12.4' with depth 2 returns 3.12
     def self.format_version_based_on_depth(version_fragment, depth = 2)
       raise Lapidario::Error, "Tried to format #{version_fragment} with inadequate depth '#{depth}'." unless depth >= 1 && depth <= 3
@@ -43,6 +49,7 @@ module Lapidario
     end
 
     def self.save_file(save_path, content)
+      content.join("\n") if content.is_a? Array
       File.write(save_path, content)
     end
 

data/lib/lapidario/version.rb

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

data/lib/lapidario.rb

@@ -64,7 +64,7 @@ module Lapidario
       if lock_version
         gem_info[:current_version] = lock_version
         gem_info[:current_version] = Lapidario::Helper.format_version_based_on_depth(lock_version, default_depth) if default_depth
-        gem_info[:version_sign] = default_sign if default_sign && !default_sign.empty?
+        gem_info[:version_sign] = default_sign
       end
     end
     new_gemfile_info

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lapidario
 version: !ruby/object:Gem::Version
-  version: 0.3alpha.0
+  version: 0.3beta.0
 platform: ruby
 authors:
 - octehren
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-05 00:00:00.000000000 Z
+date: 2023-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,9 +39,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.12'
 description: Lapidario is a Gemfile and Gemfile.lock static analyzer that helps with
-  bulk updates of gems in a project. As of version 0.1, run it in a directory with
-  both a Gemfile and Gemfile.lock to hard-code the locked versions in Gemfile.lock
-  to the Gemfile.
+  bulk updates and explicit version hard-coding of gems in a project. See https://github.com/octehren/lapidario
+  for more.
 email:
 - ehren.dev.mail@gmail.com
 executables:
@@ -68,13 +67,13 @@ files:
 - lib/lapidario/version.rb
 - lib/lockfile_info.rb
 - sig/lapidario.rbs
-homepage: https://example.com
+homepage: https://github.com/octehren/lapidario
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://example.com
-  source_code_uri: https://example.com
+  homepage_uri: https://github.com/octehren/lapidario
+  source_code_uri: https://github.com/octehren/lapidario
   changelog_uri: https://example.com
 post_install_message:
 rdoc_options: []