tog_caesar 0.1.1 → 0.1.5

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 (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +27 -23
  3. metadata +33 -29
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: defe4e0f625e3a4fc86553ff6758b90a8f09800df9a64b3861b3424071978591
4
- data.tar.gz: 10a33519fd6b53ca6542fc40b4c96c5e5f2c1f092bd2d9cc30e0ce1bd9579efb
3
+ metadata.gz: 7ba9e21708b4bbbf4cc466ec1353a0b0c3bd427bfdda744a8387db0ae0df90ea
4
+ data.tar.gz: bbeeb1e86bd9bb760c8f3d5bb60f845aff5682c530ae1ba4b6c9feac106747a3
5
5
  SHA512:
6
- metadata.gz: 8130b88ec36323c1b719817dbbdea75ee5d24bcd85e67e7524702e64fcfe2b2d279f1e4823430773ad4251b52f0e5996207de99f95c22aaf30ba371be4f90fe2
7
- data.tar.gz: b7da9b717e0fa887ad6b1437ef4f2182128c8baf129a9bdfd52e1e19b1152f3e82be46d6d166634d7ad0d842b552a4cd8d3d7455a7c163b4ceaf7a5030c4edc4
6
+ metadata.gz: 54ca3f24e83f9699ec740016eff1dc372ba6615aa735d5d7d87778e3d4abc92473837f40b6d54cf39de7a429b6ca1b333766415c60d2ebbb3a65a25a4cde8468
7
+ data.tar.gz: f42413cc880a7b1fbc8b7c6a36529ba8584fb1ca05b1d3b4680d1977e0986d6774e56d370294752330b959a608662003fe984eae9a76aed56127569aff33cf5f
data/README.md CHANGED
@@ -1,45 +1,49 @@
1
1
  # Odin Caesar Cipher
2
2
 
3
- [Project Link](https://www.theodinproject.com/paths/full-stack-ruby-on-rails/courses/ruby-programming/lessons/caesar-cipher)
3
+ This repository is a solution to the [Odin Caesar Cipher](https://www.theodinproject.com/paths/full-stack-ruby-on-rails/courses/ruby-programming/lessons/caesar-cipher) problem. This code is overkill for such a simple project. The point of this project is to practice the skills required to turn an idea into a deployment.
4
4
 
5
- ## Build the container
5
+ ## Install Gem Locally
6
6
 
7
7
  ```sh
8
- docker build . -t caesar
8
+ gem install tog_caesar
9
9
  ```
10
10
 
11
- ## Run the binary
11
+ ## Command Line Usage
12
12
 
13
13
  ```sh
14
- docker run caesar bin/caesar "my message" 5
14
+ caesar "my message" 5
15
+ # rd rjxxflj
15
16
  ```
16
17
 
17
- ## Run the tests
18
-
19
- ```sh
20
- docker run caesar rspec
21
- ```
22
-
23
- ## Use the library
18
+ ## Ruby API Usage
24
19
 
25
20
  ```ruby
21
+ require 'tog_caesar'
22
+
26
23
  Caesar.cipher("my message", 5)
24
+ # => "rd rjxxflj"
27
25
  ```
28
26
 
29
- ## Use the gem
27
+ ## Local Development
30
28
 
31
- **Gemfile**
29
+ **Requirements:** Git, Docker
32
30
 
33
- ```ruby
34
- source 'https://rubygems.org'
31
+ ```sh
32
+ # Clone the repository and open the directory
33
+ git clone git@github.com:tacoda/odin-caesar-cipher.git && cd odin-caesar-cipher/
35
34
 
36
- gem 'tog_caesar'
37
- ```
35
+ # Build the image
36
+ script/build
38
37
 
39
- **Usage**
38
+ # Clean the build and remove the image
39
+ script/clean
40
40
 
41
- ```ruby
42
- require 'tog_caesar'
41
+ # Run all rspec tests in the container
42
+ script/test
43
43
 
44
- Caesar.cipher("my message", 5)
45
- ```
44
+ # Run a particular rspec test in the container
45
+ script/test spec/caesar_spec.rb:24 --format=doc
46
+
47
+ # Run the program with arguments in the container
48
+ script/run "my message" 5
49
+ ```
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tog_caesar
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ian Johnson
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-01-16 00:00:00.000000000 Z
11
+ date: 2023-01-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rspec
@@ -24,51 +24,55 @@ dependencies:
24
24
  - - ">="
25
25
  - !ruby/object:Gem::Version
26
26
  version: '0'
27
- description: |-
27
+ description: |
28
28
  # Odin Caesar Cipher
29
29
 
30
- [Project Link](https://www.theodinproject.com/paths/full-stack-ruby-on-rails/courses/ruby-programming/lessons/caesar-cipher)
30
+ This repository is a solution to the [Odin Caesar Cipher](https://www.theodinproject.com/paths/full-stack-ruby-on-rails/courses/ruby-programming/lessons/caesar-cipher) problem. This code is overkill for such a simple project. The point of this project is to practice the skills required to turn an idea into a deployment.
31
31
 
32
- ## Build the container
32
+ ## Install Gem Locally
33
33
 
34
34
  ```sh
35
- docker build . -t caesar
35
+ gem install tog_caesar
36
36
  ```
37
37
 
38
- ## Run the binary
38
+ ## Command Line Usage
39
39
 
40
40
  ```sh
41
- docker run caesar bin/caesar "my message" 5
41
+ caesar "my message" 5
42
+ # rd rjxxflj
42
43
  ```
43
44
 
44
- ## Run the tests
45
-
46
- ```sh
47
- docker run caesar rspec
48
- ```
49
-
50
- ## Use the library
45
+ ## Ruby API Usage
51
46
 
52
47
  ```ruby
48
+ require 'tog_caesar'
49
+
53
50
  Caesar.cipher("my message", 5)
51
+ # => "rd rjxxflj"
54
52
  ```
55
53
 
56
- ## Use the gem
54
+ ## Local Development
57
55
 
58
- **Gemfile**
56
+ **Requirements:** Git, Docker
59
57
 
60
- ```ruby
61
- source 'https://rubygems.org'
58
+ ```sh
59
+ # Clone the repository and open the directory
60
+ git clone git@github.com:tacoda/odin-caesar-cipher.git && cd odin-caesar-cipher/
62
61
 
63
- gem 'tog_caesar'
64
- ```
62
+ # Build the image
63
+ script/build
65
64
 
66
- **Usage**
65
+ # Clean the build and remove the image
66
+ script/clean
67
67
 
68
- ```ruby
69
- require 'tog_caesar'
68
+ # Run all rspec tests in the container
69
+ script/test
70
70
 
71
- Caesar.cipher("my message", 5)
71
+ # Run a particular rspec test in the container
72
+ script/test spec/caesar_spec.rb:24 --format=doc
73
+
74
+ # Run the program with arguments in the container
75
+ script/run "my message" 5
72
76
  ```
73
77
  email: tacoda@hey.com
74
78
  executables:
@@ -85,7 +89,7 @@ homepage: https://github.com/tacoda/odin-caesar-cipher
85
89
  licenses:
86
90
  - MIT
87
91
  metadata: {}
88
- post_install_message:
92
+ post_install_message:
89
93
  rdoc_options: []
90
94
  require_paths:
91
95
  - lib
@@ -100,8 +104,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
100
104
  - !ruby/object:Gem::Version
101
105
  version: '0'
102
106
  requirements: []
103
- rubygems_version: 3.2.22
104
- signing_key:
107
+ rubygems_version: 3.2.33
108
+ signing_key:
105
109
  specification_version: 4
106
110
  summary: Ceasar Cipher
107
111
  test_files: