tog_caesar 0.1.0 → 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 (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +28 -18
  3. data/bin/caesar +1 -1
  4. metadata +35 -25
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6c756f618b203603dd94d35c2fba8dce42c45934d62d50b138917385b2f2c0ba
4
- data.tar.gz: 4b5218f7b893f794fc09234a43f0b147fd4eca739f36f435019128bc6175811d
3
+ metadata.gz: 7ba9e21708b4bbbf4cc466ec1353a0b0c3bd427bfdda744a8387db0ae0df90ea
4
+ data.tar.gz: bbeeb1e86bd9bb760c8f3d5bb60f845aff5682c530ae1ba4b6c9feac106747a3
5
5
  SHA512:
6
- metadata.gz: '09f94f8080509fd1b555a498c58dc36f611ca8fd55cdba1fd09e6b97690689e5a48aea1df67508b7d949f8cbe9b7c1daa4f5c3f699d7027d67348f02e71b3a15'
7
- data.tar.gz: 6e0385e25535cca8e3d808e1717cc84897678e4aef72718aaeca336f2ffacbf2a4289c68e1243fe48c9c24d9d8cacaa60b49fb57a30c493fcf2eb4b9548b7930
6
+ metadata.gz: 54ca3f24e83f9699ec740016eff1dc372ba6615aa735d5d7d87778e3d4abc92473837f40b6d54cf39de7a429b6ca1b333766415c60d2ebbb3a65a25a4cde8468
7
+ data.tar.gz: f42413cc880a7b1fbc8b7c6a36529ba8584fb1ca05b1d3b4680d1977e0986d6774e56d370294752330b959a608662003fe984eae9a76aed56127569aff33cf5f
data/README.md CHANGED
@@ -1,39 +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
- ## Run the binary
5
+ ## Install Gem Locally
6
6
 
7
7
  ```sh
8
- bin/caesar "What a string!" 5
8
+ gem install tog_caesar
9
9
  ```
10
10
 
11
- ## Run the tests
11
+ ## Command Line Usage
12
12
 
13
13
  ```sh
14
- bundle install && bundle exec rspec
14
+ caesar "my message" 5
15
+ # rd rjxxflj
15
16
  ```
16
17
 
17
- ## Use the library
18
+ ## Ruby API Usage
18
19
 
19
20
  ```ruby
20
- Caesar.cipher("What a string!", 5)
21
+ require 'tog_caesar'
22
+
23
+ Caesar.cipher("my message", 5)
24
+ # => "rd rjxxflj"
21
25
  ```
22
26
 
23
- ## Use the gem
27
+ ## Local Development
24
28
 
25
- **Gemfile**
29
+ **Requirements:** Git, Docker
26
30
 
27
- ```ruby
28
- 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/
29
34
 
30
- gem 'tog_caesar'
31
- ```
35
+ # Build the image
36
+ script/build
32
37
 
33
- **Usage**
38
+ # Clean the build and remove the image
39
+ script/clean
34
40
 
35
- ```ruby
36
- require 'tog_caesar'
41
+ # Run all rspec tests in the container
42
+ script/test
37
43
 
38
- Caesar.cipher("What a string!", 5)
39
- ```
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
+ ```
data/bin/caesar CHANGED
@@ -5,5 +5,5 @@ require_relative '../lib/caesar.rb'
5
5
  args = ARGV
6
6
 
7
7
  unless args.length < 2
8
- puts Caesar.cipher(args[0], args[1].to_i)
8
+ puts Caesar.cipher(args[0].to_s, args[1].to_i)
9
9
  end
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.0
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,45 +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
- ## Run the binary
32
+ ## Install Gem Locally
33
33
 
34
34
  ```sh
35
- bin/caesar "What a string!" 5
35
+ gem install tog_caesar
36
36
  ```
37
37
 
38
- ## Run the tests
38
+ ## Command Line Usage
39
39
 
40
40
  ```sh
41
- bundle install && bundle exec rspec
41
+ caesar "my message" 5
42
+ # rd rjxxflj
42
43
  ```
43
44
 
44
- ## Use the library
45
+ ## Ruby API Usage
45
46
 
46
47
  ```ruby
47
- Caesar.cipher("What a string!", 5)
48
+ require 'tog_caesar'
49
+
50
+ Caesar.cipher("my message", 5)
51
+ # => "rd rjxxflj"
48
52
  ```
49
53
 
50
- ## Use the gem
54
+ ## Local Development
51
55
 
52
- **Gemfile**
56
+ **Requirements:** Git, Docker
53
57
 
54
- ```ruby
55
- 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/
56
61
 
57
- gem 'tog_caesar'
58
- ```
62
+ # Build the image
63
+ script/build
59
64
 
60
- **Usage**
65
+ # Clean the build and remove the image
66
+ script/clean
61
67
 
62
- ```ruby
63
- require 'tog_caesar'
68
+ # Run all rspec tests in the container
69
+ script/test
70
+
71
+ # Run a particular rspec test in the container
72
+ script/test spec/caesar_spec.rb:24 --format=doc
64
73
 
65
- Caesar.cipher("What a string!", 5)
74
+ # Run the program with arguments in the container
75
+ script/run "my message" 5
66
76
  ```
67
77
  email: tacoda@hey.com
68
78
  executables:
@@ -79,7 +89,7 @@ homepage: https://github.com/tacoda/odin-caesar-cipher
79
89
  licenses:
80
90
  - MIT
81
91
  metadata: {}
82
- post_install_message:
92
+ post_install_message:
83
93
  rdoc_options: []
84
94
  require_paths:
85
95
  - lib
@@ -87,15 +97,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
87
97
  requirements:
88
98
  - - ">="
89
99
  - !ruby/object:Gem::Version
90
- version: '1.9'
100
+ version: '2.6'
91
101
  required_rubygems_version: !ruby/object:Gem::Requirement
92
102
  requirements:
93
103
  - - ">="
94
104
  - !ruby/object:Gem::Version
95
105
  version: '0'
96
106
  requirements: []
97
- rubygems_version: 3.2.22
98
- signing_key:
107
+ rubygems_version: 3.2.33
108
+ signing_key:
99
109
  specification_version: 4
100
110
  summary: Ceasar Cipher
101
111
  test_files: