lucy_dockerunner 0.1.6 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +59 -10
  4. data/lib/lucy_dockerunner/version.rb +1 -1
  5. metadata +2 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ed51fadc53b795aa23350c7ce49b87d25234cee22ed9a65d310815077f5b8972
4
- data.tar.gz: ca61bacb4fc54f6432ddb5bca8167343881410ac2ae4eb7198c824dd91c5d20d
3
+ metadata.gz: b7902c6fdd608e972b6025b32f6ef8731e37fa5e8249ef0446f0503ff450e184
4
+ data.tar.gz: ff2d987b86f299f91fe34060adfe93b07a00199f44cd3afdf730ce5347797878
5
5
  SHA512:
6
- metadata.gz: 8a4f5083d80a651b373d23cac7edead9f248defe9a2590c8653ed3f9bfc63094ed8dc8ba6d12f6bf1c107bd816442398bcf18b88164fe96657377cbdf03a9e6e
7
- data.tar.gz: c9be619deded43389003507a4c2893cb602be2fd35511c2c6873c00ca36a6d9f20c4d24ec05b630f1104d3544b653f3805d3a7d36b0f54c96469cc5b922fedd3
6
+ metadata.gz: 7f530d7c039fc703c258e6c791a12367255c7ca4cc1d0ee2e5eda38f5ad5686c532889e4b3a11a4b9137c6a00b93ee78a8c4b78d82d03b8ea151421ce00ce947
7
+ data.tar.gz: 6b58db241568b140abff172148afef7bae3986357ed6dd7fe56abe4f354fdacc427072718332e2fe9751fc5628d8431ea7e09fbbc5b7a98c1100622ab34b1b94
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- lucy_dockerunner (0.1.6)
4
+ lucy_dockerunner (0.1.7)
5
5
 
6
6
  GEM
7
7
  remote: https://rubygems.org/
data/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # LucyDockerunner
1
+ # Lucy Dockerunner
2
2
 
3
3
  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.
4
4
 
@@ -8,8 +8,26 @@ Lucy Dockerunner is a Ruby gem that provides a simple wrapper around the Docker
8
8
 
9
9
  Ruby version: >= 2.6.0
10
10
 
11
- This gem version: 0.1.4
11
+ This gem version: 0.1.7
12
12
 
13
+ ## Dependencies
14
+
15
+ * [Docker](https://www.docker.com/)
16
+ * [Docker Compose](https://docs.docker.com/compose/)
17
+ * [Ruby On Rails](https://rubyonrails.org/) - or any other Ruby project that uses Docker Compose to run the project with specific services.
18
+
19
+ ## Files
20
+ This gem uses the following files to run the docker compose services:
21
+
22
+ - Dockerfile
23
+ - docker-compose.yml - development
24
+ - docker-compose.prod.yml - production
25
+
26
+ It's important to have .env files separated by environment, for example:
27
+ - .env.development
28
+ - .env.production
29
+
30
+ 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.
13
31
  ## Installation
14
32
 
15
33
  You can install the gem by executing:
@@ -29,7 +47,7 @@ require 'lucy_dockerunner'
29
47
  LucyDockerunner.load_tasks
30
48
  ````
31
49
 
32
- ###### Docker actions
50
+ ## Docker actions
33
51
  * `rake compose:install` - build docker compose and migrate the database
34
52
  * `rake compose:build` - build docker compose services
35
53
  * `rake compose:up` - start the docker compose services
@@ -45,7 +63,26 @@ LucyDockerunner.load_tasks
45
63
  * `rake compose:clean_volumes` - clean all docker compose volumes
46
64
  * `rake compose:clean_orphans` - clean all docker compose orphans
47
65
  * `rake compose:clean_containers` - clean all docker compose containers
48
- #### Database actions
66
+
67
+ ## Docker Production actions
68
+
69
+ * `rake compose_prod:install` - build docker compose and migrate the database
70
+ * `rake compose_prod:build` - build docker compose services
71
+ * `rake compose_prod:up` - start the docker compose services
72
+ * `rake compose_prod:down` - stop the docker compose services
73
+ * `rake compose_prod:status` - show the status of the docker compose services
74
+ * `rake compose_prod:shell` - open a shell in the web service
75
+ * `rake compose_prod:db_detach` - detach the database from the docker compose services
76
+ * `rake compose_prod:redis_detach` - detach the redis from the docker compose services
77
+ * `rake compose_prod:back_detach` - detach the backend(redis, sidekiq, db) from the docker compose services
78
+ * `rake compose_prod:restart` - restart the docker compose services
79
+ * `rake compose_prod:clean_all` - clean all docker compose services
80
+ * `rake compose_prod:clean_images` - clean all docker compose images
81
+ * `rake compose_prod:clean_volumes` - clean all docker compose volumes
82
+ * `rake compose_prod:clean_orphans` - clean all docker compose orphans
83
+ * `rake compose_prod:clean_containers` - clean all docker compose containers
84
+
85
+ ## Database actions
49
86
  * `rake compose_db:migrate` - migrate the database
50
87
  * `rake compose_db:reset` - reset the database
51
88
  * `rake compose_db:drop` - drop the database
@@ -57,7 +94,7 @@ LucyDockerunner.load_tasks
57
94
  * `rake compose_db:reset_setup` - drop and setup the database
58
95
  * `rake compose_db:reset` - reset the database
59
96
 
60
- ### Tests actions
97
+ ## Tests actions
61
98
  * `rake compose_test:all` - run all tests
62
99
  * `rake compose_test:clean_all` - run all tests after cleaning docker compose services
63
100
  * `rake compose_test:controllers` - run controllers tests
@@ -68,7 +105,7 @@ LucyDockerunner.load_tasks
68
105
  * `rake compose_test:routing` - run routing tests
69
106
  * `rake compose_test:views` - run views tests
70
107
 
71
- ### LOGS actions
108
+ ## LOGS actions
72
109
  * `rake compose_logs:web` - show web logs
73
110
  * `rake compose_logs:db` - show db logs
74
111
  * `rake compose_logs:redis` - show redis logs
@@ -80,13 +117,16 @@ LucyDockerunner.load_tasks
80
117
  * `rake compose_logs:tail_sidekiq` - tail sidekiq logs
81
118
  * `rake compose_logs:tail_all` - tail all logs
82
119
 
120
+ ## Assets actions
121
+ * `rake compose_assets:precompile` - precompile assets
122
+ * `rake compose_assets:clean` - clean assets
123
+ * `rake compose_assets:clobber` - clobber assets
124
+
125
+
83
126
  ## Start the docker compose services
84
127
  ````bash
85
128
  $ rake compose:up
86
129
  ````
87
- ### Access the web service
88
- http://localhost
89
-
90
130
 
91
131
  ## References
92
132
  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
94
134
 
95
135
  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).
96
136
 
137
+
138
+ ## [![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)
139
+ [![Timeline graph](https://images.repography.com/33522702/JesusGautamah/lucy_dockerunner/recent-activity/7YfytFwl78FgWgAtJeO7jReo0y6GD6YPifcYNBxOxaE/yhI9H3pCZlEkfuvJLU9LC32UBu1c8k5toFvgUDmttdM_timeline.svg)](https://github.com/JesusGautamah/lucy_dockerunner/commits)
140
+ [![Issue status graph](https://images.repography.com/33522702/JesusGautamah/lucy_dockerunner/recent-activity/7YfytFwl78FgWgAtJeO7jReo0y6GD6YPifcYNBxOxaE/yhI9H3pCZlEkfuvJLU9LC32UBu1c8k5toFvgUDmttdM_issues.svg)](https://github.com/JesusGautamah/lucy_dockerunner/issues)
141
+ [![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)
142
+ [![Top contributors](https://images.repography.com/33522702/JesusGautamah/lucy_dockerunner/recent-activity/7YfytFwl78FgWgAtJeO7jReo0y6GD6YPifcYNBxOxaE/yhI9H3pCZlEkfuvJLU9LC32UBu1c8k5toFvgUDmttdM_users.svg)](https://github.com/JesusGautamah/lucy_dockerunner/graphs/contributors)
143
+
144
+
145
+
97
146
  ## License
98
147
 
99
148
  The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
100
149
 
101
150
  ## Code of Conduct
102
151
 
103
- 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).
152
+ 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 CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module LucyDockerunner
4
- VERSION = "0.1.6"
4
+ VERSION = "0.1.7"
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: lucy_dockerunner
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.6
4
+ version: 0.1.7
5
5
  platform: ruby
6
6
  authors:
7
7
  - JesusGautamah
@@ -12,8 +12,7 @@ date: 2023-02-16 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: |-
14
14
  This gem is a tool to run docker containers with rake commands, good for CI/CD and Rails projects.
15
- It's a wrapper for docker-compose commands and original code was developed
16
- by me in the project https://github.com/JesusGautamah/outerspace-blockchain
15
+ Docs: https://github.com/JesusGautamah/lucy_dockerunner
17
16
  email:
18
17
  - lima.jesuscc@gmail.com
19
18
  executables: []