lucy_dockerunner 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4446f3dd1ecb3193d0868bd3247ffa451352bddee1cf81e5d8e9bf9aad3936cb
-  data.tar.gz: cc912d91c7691de292b7ea115a0fcada45871057d3a10e69132a088cdad5c294
+  metadata.gz: b7902c6fdd608e972b6025b32f6ef8731e37fa5e8249ef0446f0503ff450e184
+  data.tar.gz: ff2d987b86f299f91fe34060adfe93b07a00199f44cd3afdf730ce5347797878
 SHA512:
-  metadata.gz: 1e48250f0baca9e750660853c344d4cf99abf7e6290d12aebb2ea07955e1964076af66417bdb391cf719d7f337c989c23bc9879bf0c722ee88dc370306e7a41c
-  data.tar.gz: fd287ccf462d6017fc054ccf2e7075a6f17ccf871c24c4a29d60126adc8ab8394bd13462a0773dfb917584ad76649853354679b4705148365f92e7a97d22eb86
+  metadata.gz: 7f530d7c039fc703c258e6c791a12367255c7ca4cc1d0ee2e5eda38f5ad5686c532889e4b3a11a4b9137c6a00b93ee78a8c4b78d82d03b8ea151421ce00ce947
+  data.tar.gz: 6b58db241568b140abff172148afef7bae3986357ed6dd7fe56abe4f354fdacc427072718332e2fe9751fc5628d8431ea7e09fbbc5b7a98c1100622ab34b1b94

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
   TargetRubyVersion: 2.6
+  SuggestExtensions: false
+  NewCops: enable
 
 Style/StringLiterals:
   Enabled: true
@@ -10,4 +12,9 @@ Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 
 Layout/LineLength:
-  Max: 120
+  Max: 180
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/tasks/**/*'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lucy_dockerunner (0.1.5)
+    lucy_dockerunner (0.1.7)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,4 +1,4 @@
-# LucyDockerunner
+# Lucy Dockerunner
 
 Lucy Dockerunner is a Ruby gem that provides a simple wrapper around the Docker Compose CLI to make it easier to run Docker Compose commands from Ruby On Rails projects.
 
@@ -8,8 +8,26 @@ Lucy Dockerunner is a Ruby gem that provides a simple wrapper around the Docker
 
 Ruby version: >= 2.6.0
 
-This gem version: 0.1.4
+This gem version: 0.1.7
 
+## Dependencies
+
+* [Docker](https://www.docker.com/)
+* [Docker Compose](https://docs.docker.com/compose/)
+* [Ruby On Rails](https://rubyonrails.org/) - or any other Ruby project that uses Docker Compose to run the project with specific services.
+
+## Files
+This gem uses the following files to run the docker compose services:
+
+- Dockerfile
+- docker-compose.yml - development
+- docker-compose.prod.yml - production
+
+It's important to have .env files separated by environment, for example:
+- .env.development
+- .env.production
+
+And remember to add the .env files to the .gitignore file and reference them in the docker-compose.yml and docker-compose.prod.yml files.
 ## Installation
 
 You can install the gem by executing:
@@ -29,7 +47,7 @@ require 'lucy_dockerunner'
 LucyDockerunner.load_tasks
 ````
 
-###### Docker actions
+## Docker actions
 * `rake compose:install` - build docker compose and migrate the database
 * `rake compose:build` - build docker compose services
 * `rake compose:up` - start the docker compose services
@@ -45,7 +63,26 @@ LucyDockerunner.load_tasks
 * `rake compose:clean_volumes` - clean all docker compose volumes
 * `rake compose:clean_orphans` - clean all docker compose orphans
 * `rake compose:clean_containers` - clean all docker compose containers
-#### Database actions
+
+## Docker Production actions
+
+* `rake compose_prod:install` - build docker compose and migrate the database
+* `rake compose_prod:build` - build docker compose services
+* `rake compose_prod:up` - start the docker compose services
+* `rake compose_prod:down` - stop the docker compose services
+* `rake compose_prod:status` - show the status of the docker compose services
+* `rake compose_prod:shell` - open a shell in the web service
+* `rake compose_prod:db_detach` - detach the database from the docker compose services
+* `rake compose_prod:redis_detach` - detach the redis from the docker compose services
+* `rake compose_prod:back_detach` - detach the backend(redis, sidekiq, db) from the docker compose services
+* `rake compose_prod:restart` - restart the docker compose services
+* `rake compose_prod:clean_all` - clean all docker compose services
+* `rake compose_prod:clean_images` - clean all docker compose images
+* `rake compose_prod:clean_volumes` - clean all docker compose volumes
+* `rake compose_prod:clean_orphans` - clean all docker compose orphans
+* `rake compose_prod:clean_containers` - clean all docker compose containers
+
+## Database actions
 * `rake compose_db:migrate` - migrate the database
 * `rake compose_db:reset` - reset the database
 * `rake compose_db:drop` - drop the database
@@ -57,7 +94,7 @@ LucyDockerunner.load_tasks
 * `rake compose_db:reset_setup` - drop and setup the database
 * `rake compose_db:reset` - reset the database
 
-### Tests actions
+## Tests actions
 * `rake compose_test:all` - run all tests
 * `rake compose_test:clean_all` - run all tests after cleaning docker compose services
 * `rake compose_test:controllers` - run controllers tests
@@ -68,7 +105,7 @@ LucyDockerunner.load_tasks
 * `rake compose_test:routing` - run routing tests
 * `rake compose_test:views` - run views tests
 
-### LOGS actions
+## LOGS actions
 * `rake compose_logs:web` - show web logs
 * `rake compose_logs:db` - show db logs
 * `rake compose_logs:redis` - show redis logs
@@ -80,13 +117,16 @@ LucyDockerunner.load_tasks
 * `rake compose_logs:tail_sidekiq` - tail sidekiq logs
 * `rake compose_logs:tail_all` - tail all logs
 
+## Assets actions
+* `rake compose_assets:precompile` - precompile assets
+* `rake compose_assets:clean` - clean assets
+* `rake compose_assets:clobber` - clobber assets
+
+
 ## Start the docker compose services
 ````bash
 $ rake compose:up
 ````
-### Access the web service
-http://localhost
-
 
 ## References
 The code code inside the 'lib/rake/lucyd_hooks.rb' file is based on the code of the [rake-hooks](https://github.com/guillermo/rake-hooks) from Guillermo Iguaran, Joel Moss as described in the [Ruby Toolbox](https://www.ruby-toolbox.com/projects/rake-hooks) page.
@@ -94,10 +134,19 @@ The code code inside the 'lib/rake/lucyd_hooks.rb' file is based on the code of
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/JesusGautamah/lucy_dockerunner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/JesusGautamah/lucy_dockerunner/blob/master/CODE_OF_CONDUCT.md).
 
+
+## [![Repography logo](https://images.repography.com/logo.svg)](https://repography.com) / Recent activity [![Time period](https://images.repography.com/33522702/JesusGautamah/lucy_dockerunner/recent-activity/7YfytFwl78FgWgAtJeO7jReo0y6GD6YPifcYNBxOxaE/yhI9H3pCZlEkfuvJLU9LC32UBu1c8k5toFvgUDmttdM_badge.svg)](https://repography.com)
+[![Timeline graph](https://images.repography.com/33522702/JesusGautamah/lucy_dockerunner/recent-activity/7YfytFwl78FgWgAtJeO7jReo0y6GD6YPifcYNBxOxaE/yhI9H3pCZlEkfuvJLU9LC32UBu1c8k5toFvgUDmttdM_timeline.svg)](https://github.com/JesusGautamah/lucy_dockerunner/commits)
+[![Issue status graph](https://images.repography.com/33522702/JesusGautamah/lucy_dockerunner/recent-activity/7YfytFwl78FgWgAtJeO7jReo0y6GD6YPifcYNBxOxaE/yhI9H3pCZlEkfuvJLU9LC32UBu1c8k5toFvgUDmttdM_issues.svg)](https://github.com/JesusGautamah/lucy_dockerunner/issues)
+[![Pull request status graph](https://images.repography.com/33522702/JesusGautamah/lucy_dockerunner/recent-activity/7YfytFwl78FgWgAtJeO7jReo0y6GD6YPifcYNBxOxaE/yhI9H3pCZlEkfuvJLU9LC32UBu1c8k5toFvgUDmttdM_prs.svg)](https://github.com/JesusGautamah/lucy_dockerunner/pulls)
+[![Top contributors](https://images.repography.com/33522702/JesusGautamah/lucy_dockerunner/recent-activity/7YfytFwl78FgWgAtJeO7jReo0y6GD6YPifcYNBxOxaE/yhI9H3pCZlEkfuvJLU9LC32UBu1c8k5toFvgUDmttdM_users.svg)](https://github.com/JesusGautamah/lucy_dockerunner/graphs/contributors)
+
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the LucyDockerunner project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/JesusGautamah/lucy_dockerunner/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the LucyDockerunner project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/JesusGautamah/lucy_dockerunner/blob/master/CODE_OF_CONDUCT.md).

data/lib/lucy_dockerunner/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LucyDockerunner
-  VERSION = "0.1.5"
+  VERSION = "0.1.7"
 end

data/lib/rake/lucyd_hooks.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-# Rake::LucydHooks from https://github.com/guillermo/rake-hooks, authors Guillermo Iguaran, Joel Moss
+# from https://github.com/guillermo/rake-hooks, authors Guillermo Iguaran, Joel Moss
 module Rake
+  # module Rake::Hooks
   module LucydHooks
-    def before(*task_names, &new_task)
+    def bef(*task_names, &new_task)
       task_names.each do |task_name|
         old_task = Rake.application.instance_variable_get("@tasks").delete(task_name.to_s)
         next unless old_task
@@ -15,29 +16,8 @@ module Rake
         end
       end
     end
-
-    def after(*task_names, &new_task)
-      options = task_names.last.is_a?(Hash) ? task_names.pop : {}
-      ignore_exceptions = options.delete(:ignore_exceptions) || false
-
-      task_names.each do |task_name|
-        old_task = Rake.application.instance_variable_get("@tasks").delete(task_name.to_s)
-        next unless old_task
-
-        desc old_task.full_comment if old_task.respond_to?(:full_comment)
-        task task_name => old_task.prerequisites do
-          begin
-            old_task.invoke
-          rescue StandardError
-            raise unless ignore_exceptions
-          end
-
-          new_task.call
-        end
-      end
-    end
   end
-end
 
-Rake::DSL.include Rake::LucydHooks if defined?(Rake::DSL)
-include Rake::LucydHooks unless self.class.included_modules.include?(Rake::LucydHooks)
+  Rake::DSL.include Rake::LucydHooks if defined?(Rake::DSL)
+  include Rake::LucydHooks unless self.class.included_modules.include?(Rake::LucydHooks)
+end

data/lib/tasks/compose.rake

@@ -187,8 +187,10 @@ end
 
 tasks_names.each do |task|
   before_action = "#{namesp}:#{task}"
-  before before_action do
-    dockerfile_checker ? abort("Dockerfile not found.\nYou must have a Dockerfile file.") : nil
-    compose_checker ? (abort "Compose file not found.\nFor development, you must have a #{dev_compose_file} file.") : nil
+  bef before_action do
+    docker_abort_error = "Dockerfile not found.\nYou must have a Dockerfile file."
+    compose_abort_error = "Compose file not found.\nFor development, you must have a #{dev_compose_file} file."
+    dockerfile_checker ? abort(docker_abort_error) : puts("Dockerfile found.")
+    compose_checker ? abort(compose_abort_error) : puts("Compose file found.")
   end
 end

data/lib/tasks/compose_assets.rake

@@ -9,7 +9,7 @@ def task_helper
 end
 
 def compose_command
-  @compose_comand ||= task_helper.compose_command
+  @compose_command ||= task_helper.compose_command
 end
 
 namespace :compose_assets do

data/lib/tasks/compose_db.rake

@@ -8,7 +8,7 @@ def task_helper
 end
 
 def compose_command
-  @compose_comand ||= task_helper.compose_command
+  @compose_command ||= task_helper.compose_command
 end
 
 namespace :compose_db do

data/lib/tasks/compose_logs.rake

@@ -8,7 +8,7 @@ def task_helper
 end
 
 def compose_command
-  @compose_comand ||= task_helper.compose_command
+  @compose_command ||= task_helper.compose_command
 end
 
 namespace :compose_logs do

data/lib/tasks/compose_prod.rake

@@ -38,7 +38,8 @@ namespace :compose_prod do
   end
 
   task :install do
-    puts "Installing Blockchain and Database Containers \nWARNING: This will delete all your data, and you are running this in production"
+    puts "Installing Blockchain and Database Containers \n
+    WARNING: This will delete all your data, and you are running this in production"
     # ask in terminal if you want to continue
     choice = ask("Are you sure you want to continue? (y/n)")
     if choice == "y"
@@ -241,8 +242,10 @@ end
 
 tasks_names.each do |task|
   before_action = "#{namesp}:#{task}"
-  before before_action do
-    dockerfile_checker ? abort("Dockerfile not found.\nYou must have a Dockerfile file.") : nil
-    compose_checker ? (abort "Compose file not found.\nFor development, you must have a #{compose_file} file.") : nil
+  bef before_action do
+    docker_abort_error = "Dockerfile not found.\nYou must have a Dockerfile file."
+    compose_abort_error = "Compose file not found.\nYou must have a docker-compose.prod.yml file."
+    dockerfile_checker ? abort(docker_abort_error) : puts("Dockerfile found")
+    compose_checker ? abort(compose_abort_error) : puts("Compose Production file found")
   end
 end

data/lib/tasks/compose_test.rake

@@ -8,7 +8,7 @@ def task_helper
 end
 
 def compose_command
-  @compose_comand ||= task_helper.compose_command
+  @compose_command ||= task_helper.compose_command
 end
 
 namespace :compose_test do

data/lib/tasks/task_helpers/compose_taskhelper.rb

@@ -4,9 +4,10 @@ require "English"
 require_relative "taskhelper"
 
 module TaskHelpers
+  # ComposeTaskhelper
   class ComposeTaskhelper < TaskHelpers::Taskhelper
     def compose_command
-      @compose_comand ||= compose_command_finder
+      @compose_command ||= compose_command_finder
     end
 
     private
@@ -17,9 +18,9 @@ module TaskHelpers
         system "#{command} --version > /dev/null 2>&1"
         return command if $CHILD_STATUS.success?
 
-        command = false unless $CHILD_STATUS.success?
+        command = false
+        raise ComposeError if command == false
       end
-      raise ComposeError unless command == false
     end
   end
 end

data/lib/tasks/task_helpers/taskhelper.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module TaskHelpers
+  # Taskhelper
   class Taskhelper
+    # Compose Error
     class ComposeError < StandardError
       def initialize(message = "Docker Compose is not installed")
         super
@@ -10,15 +12,16 @@ module TaskHelpers
 
     private
 
-    def dev_error(e)
+    def dev_error(error)
       return unless env_acceptable?
 
-      puts "#{e.class}: #{e.message}"
-      puts e.backtrace
+      puts "#{error.class}: #{error.message}"
+      puts error.backtrace
     end
 
     def env_acceptable?
-      Rails.env.development? || Rails.env.test?
+      # Rails.env.development? || Rails.env.test?
+      true
     end
   end
 end

metadata

@@ -1,19 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: lucy_dockerunner
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - JesusGautamah
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-02-16 00:00:00.000000000 Z
 dependencies: []
 description: |-
   This gem is a tool to run docker containers with rake commands, good for CI/CD and Rails projects.
-    It's a wrapper for docker-compose commands and original code was developed
-    by me in the project https://github.com/JesusGautamah/outerspace-blockchain
+    Docs: https://github.com/JesusGautamah/lucy_dockerunner
 email:
 - lima.jesuscc@gmail.com
 executables: []
@@ -51,6 +50,7 @@ metadata:
   homepage_uri: https://github.com/JesusGautamah/lucy_dockerunner
   source_code_uri: https://github.com/JesusGautamah/lucy_dockerunner
   changelog_uri: https://github.com/JesusGautamah/lucy_dockerunner/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -66,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: This gem is a tool to run docker containers with rake commands, good for