rcli_app 0.2.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +27 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +15 -0
- data/Gemfile.lock +86 -0
- data/LICENSE +21 -0
- data/README.md +64 -0
- data/Rakefile +10 -0
- data/bin/console +14 -0
- data/bin/run.rb +3 -0
- data/bin/setup +8 -0
- data/config/environment.rb +6 -0
- data/lib/cli.rb +9 -0
- data/lib/rcli_app.rb +7 -0
- data/lib/rcli_app/builder.rb +10 -0
- data/lib/rcli_app/version.rb +5 -0
- data/rcli_app.gemspec +24 -0
- metadata +61 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 6164524c6aa654eae1f328c626a3df45dd36e181f72947565b74415c44582af4
|
4
|
+
data.tar.gz: d56d0f48a4f17662fb4ee7349e665b11f27ae602bf0ef2fccd1dae535d40983e
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 84d73c728216821fbcc393feb1b6241976da5d2c869bd0ca5ebf091b57c1871ba9963e7684c5ba9bb884948e5d06f4ca67e65ed48bba49616b0141504267ffd3
|
7
|
+
data.tar.gz: a19b20f3dc26d88ead156d574efc69c45a7954ad4acabaee288ac0ccf5e6b291620756d62e64d98eb230c6f427290281d22a19ead0ac098a42d3294b1569a14f
|
data/.gitignore
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
/.bundle/
|
2
|
+
/.yardoc
|
3
|
+
/_yardoc/
|
4
|
+
/coverage/
|
5
|
+
/doc/
|
6
|
+
/pkg/
|
7
|
+
/spec/reports/
|
8
|
+
/tmp/
|
9
|
+
|
10
|
+
.DS_Store
|
11
|
+
.idea
|
12
|
+
|
13
|
+
log
|
14
|
+
node_modules
|
15
|
+
out
|
16
|
+
tmp
|
17
|
+
|
18
|
+
*.iml
|
19
|
+
*.log
|
20
|
+
*.swp
|
21
|
+
|
22
|
+
db/*.db
|
23
|
+
|
24
|
+
*.env
|
25
|
+
|
26
|
+
*.gem
|
27
|
+
# Ignore application configuration
|
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at alex.beciana@gmail.com. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [https://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: https://contributor-covenant.org
|
74
|
+
[version]: https://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
source "https://rubygems.org"
|
2
|
+
|
3
|
+
# Specify your gem's dependencies in rcli_app.gemspec
|
4
|
+
gemspec
|
5
|
+
|
6
|
+
gem "rake", "~> 13.0.1"
|
7
|
+
gem "activerecord", '~> 5.2'
|
8
|
+
gem "sinatra-activerecord"
|
9
|
+
gem "sqlite3", '~> 1.3.6'
|
10
|
+
gem "pry"
|
11
|
+
gem "require_all"
|
12
|
+
gem "faker"
|
13
|
+
gem 'tty-prompt'
|
14
|
+
gem "colorize"
|
15
|
+
gem "dotenv"
|
data/Gemfile.lock
ADDED
@@ -0,0 +1,86 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
rcli_app (0.2.1)
|
5
|
+
|
6
|
+
GEM
|
7
|
+
remote: https://rubygems.org/
|
8
|
+
specs:
|
9
|
+
activemodel (5.2.4.3)
|
10
|
+
activesupport (= 5.2.4.3)
|
11
|
+
activerecord (5.2.4.3)
|
12
|
+
activemodel (= 5.2.4.3)
|
13
|
+
activesupport (= 5.2.4.3)
|
14
|
+
arel (>= 9.0)
|
15
|
+
activesupport (5.2.4.3)
|
16
|
+
concurrent-ruby (~> 1.0, >= 1.0.2)
|
17
|
+
i18n (>= 0.7, < 2)
|
18
|
+
minitest (~> 5.1)
|
19
|
+
tzinfo (~> 1.1)
|
20
|
+
arel (9.0.0)
|
21
|
+
coderay (1.1.3)
|
22
|
+
colorize (0.8.1)
|
23
|
+
concurrent-ruby (1.1.6)
|
24
|
+
dotenv (2.7.6)
|
25
|
+
faker (2.13.0)
|
26
|
+
i18n (>= 1.6, < 2)
|
27
|
+
i18n (1.8.4)
|
28
|
+
concurrent-ruby (~> 1.0)
|
29
|
+
method_source (1.0.0)
|
30
|
+
minitest (5.14.1)
|
31
|
+
mustermann (1.1.1)
|
32
|
+
ruby2_keywords (~> 0.0.1)
|
33
|
+
pastel (0.8.0)
|
34
|
+
tty-color (~> 0.5)
|
35
|
+
pry (0.13.1)
|
36
|
+
coderay (~> 1.1)
|
37
|
+
method_source (~> 1.0)
|
38
|
+
rack (2.2.3)
|
39
|
+
rack-protection (2.0.8.1)
|
40
|
+
rack
|
41
|
+
rake (13.0.1)
|
42
|
+
require_all (3.0.0)
|
43
|
+
ruby2_keywords (0.0.2)
|
44
|
+
sinatra (2.0.8.1)
|
45
|
+
mustermann (~> 1.0)
|
46
|
+
rack (~> 2.0)
|
47
|
+
rack-protection (= 2.0.8.1)
|
48
|
+
tilt (~> 2.0)
|
49
|
+
sinatra-activerecord (2.0.18)
|
50
|
+
activerecord (>= 4.1)
|
51
|
+
sinatra (>= 1.0)
|
52
|
+
sqlite3 (1.3.13)
|
53
|
+
thread_safe (0.3.6)
|
54
|
+
tilt (2.0.10)
|
55
|
+
tty-color (0.5.1)
|
56
|
+
tty-cursor (0.7.1)
|
57
|
+
tty-prompt (0.22.0)
|
58
|
+
pastel (~> 0.8)
|
59
|
+
tty-reader (~> 0.8)
|
60
|
+
tty-reader (0.8.0)
|
61
|
+
tty-cursor (~> 0.7)
|
62
|
+
tty-screen (~> 0.8)
|
63
|
+
wisper (~> 2.0)
|
64
|
+
tty-screen (0.8.1)
|
65
|
+
tzinfo (1.2.7)
|
66
|
+
thread_safe (~> 0.1)
|
67
|
+
wisper (2.0.1)
|
68
|
+
|
69
|
+
PLATFORMS
|
70
|
+
ruby
|
71
|
+
|
72
|
+
DEPENDENCIES
|
73
|
+
activerecord (~> 5.2)
|
74
|
+
colorize
|
75
|
+
dotenv
|
76
|
+
faker
|
77
|
+
pry
|
78
|
+
rake (~> 13.0.1)
|
79
|
+
rcli_app!
|
80
|
+
require_all
|
81
|
+
sinatra-activerecord
|
82
|
+
sqlite3 (~> 1.3.6)
|
83
|
+
tty-prompt
|
84
|
+
|
85
|
+
BUNDLED WITH
|
86
|
+
2.1.4
|
data/LICENSE
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2020 Alexander Beciana
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,64 @@
|
|
1
|
+
# RcliApp
|
2
|
+
|
3
|
+
A gem to help you get started quickly with your own Ruby command-line application.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Install the gem as:
|
8
|
+
|
9
|
+
$ gem install rcli_app
|
10
|
+
|
11
|
+
|
12
|
+
Use the following command to create the folder structure:
|
13
|
+
|
14
|
+
$ gem unpack rcli_app
|
15
|
+
|
16
|
+
Then, run:
|
17
|
+
|
18
|
+
$ bundle install
|
19
|
+
|
20
|
+
## Usage
|
21
|
+
|
22
|
+
This gem focuses on helping beginner Rubyists get started with creating their own command-line applications.
|
23
|
+
|
24
|
+
After installation, you can start building your domain models and creating your application.
|
25
|
+
|
26
|
+
## Development
|
27
|
+
|
28
|
+
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
29
|
+
|
30
|
+
## Getting Started
|
31
|
+
|
32
|
+
Please create your domain model files in `lib`. Do not delete the `rcli_app` folder as well as the `rcli_app.rb` file under lib. I added a file called `cli.rb` in `lib` as well.
|
33
|
+
|
34
|
+
Additionally, run the app via `bin/run.rb` which will run the `CLI.hello` method.
|
35
|
+
|
36
|
+
If you're interested in working with an API, the `dotenv` gem is in `Gemfile` and will get installed via the last step of the installation instructions. You will need to create a `.env` file to hide your API key as well.
|
37
|
+
|
38
|
+
## Gems
|
39
|
+
|
40
|
+
* gem "rake", "~> 13.0.1"
|
41
|
+
* gem "activerecord", '~> 5.2'
|
42
|
+
* gem "sinatra-activerecord"
|
43
|
+
* gem "sqlite3", '~> 1.3.6'
|
44
|
+
* gem "pry"
|
45
|
+
* gem "require_all"
|
46
|
+
* gem "faker"
|
47
|
+
* gem 'tty-prompt'
|
48
|
+
* gem "colorize"
|
49
|
+
* gem "dotenv"
|
50
|
+
|
51
|
+
|
52
|
+
## Contributing
|
53
|
+
|
54
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/abeciana1/rcli_app. 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/abeciana1/rcli_app/blob/master/CODE_OF_CONDUCT.md).
|
55
|
+
|
56
|
+
|
57
|
+
## Code of Conduct
|
58
|
+
|
59
|
+
Everyone interacting in the RcliApp project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/abeciana1/rcli_app/blob/master/CODE_OF_CONDUCT.md).
|
60
|
+
|
61
|
+
### License
|
62
|
+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
|
63
|
+
|
64
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
require "pry"
|
3
|
+
require "bundler/setup"
|
4
|
+
require "rcli_app"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with the gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/run.rb
ADDED
data/bin/setup
ADDED
data/lib/cli.rb
ADDED
data/lib/rcli_app.rb
ADDED
data/rcli_app.gemspec
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
lib = File.expand_path('../lib', __FILE__)
|
2
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
3
|
+
require_relative 'lib/rcli_app/version'
|
4
|
+
|
5
|
+
Gem::Specification.new do |spec|
|
6
|
+
spec.name = "rcli_app"
|
7
|
+
spec.version = RcliApp::VERSION
|
8
|
+
spec.authors = ["Alex Beciana"]
|
9
|
+
spec.email = ["alex.beciana@gmail.com"]
|
10
|
+
|
11
|
+
spec.summary = %q{A gem to help beginner Rubyists get started quickly with their own Ruby command-line application. Please read the README on https://github.com/abeciana1/rcli_app}
|
12
|
+
spec.homepage = "https://github.com/abeciana1/rcli_app"
|
13
|
+
spec.license = "MIT"
|
14
|
+
spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
|
15
|
+
|
16
|
+
spec.metadata["homepage_uri"] = spec.homepage
|
17
|
+
|
18
|
+
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
19
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
20
|
+
end
|
21
|
+
spec.bindir = "exe"
|
22
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
23
|
+
spec.require_paths = ["lib"]
|
24
|
+
end
|
metadata
ADDED
@@ -0,0 +1,61 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: rcli_app
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.2.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Alex Beciana
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-07-25 00:00:00.000000000 Z
|
12
|
+
dependencies: []
|
13
|
+
description:
|
14
|
+
email:
|
15
|
+
- alex.beciana@gmail.com
|
16
|
+
executables: []
|
17
|
+
extensions: []
|
18
|
+
extra_rdoc_files: []
|
19
|
+
files:
|
20
|
+
- ".gitignore"
|
21
|
+
- CODE_OF_CONDUCT.md
|
22
|
+
- Gemfile
|
23
|
+
- Gemfile.lock
|
24
|
+
- LICENSE
|
25
|
+
- README.md
|
26
|
+
- Rakefile
|
27
|
+
- bin/console
|
28
|
+
- bin/run.rb
|
29
|
+
- bin/setup
|
30
|
+
- config/environment.rb
|
31
|
+
- lib/cli.rb
|
32
|
+
- lib/rcli_app.rb
|
33
|
+
- lib/rcli_app/builder.rb
|
34
|
+
- lib/rcli_app/version.rb
|
35
|
+
- rcli_app.gemspec
|
36
|
+
homepage: https://github.com/abeciana1/rcli_app
|
37
|
+
licenses:
|
38
|
+
- MIT
|
39
|
+
metadata:
|
40
|
+
homepage_uri: https://github.com/abeciana1/rcli_app
|
41
|
+
post_install_message:
|
42
|
+
rdoc_options: []
|
43
|
+
require_paths:
|
44
|
+
- lib
|
45
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
46
|
+
requirements:
|
47
|
+
- - ">="
|
48
|
+
- !ruby/object:Gem::Version
|
49
|
+
version: 2.3.0
|
50
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
requirements: []
|
56
|
+
rubygems_version: 3.1.4
|
57
|
+
signing_key:
|
58
|
+
specification_version: 4
|
59
|
+
summary: A gem to help beginner Rubyists get started quickly with their own Ruby command-line
|
60
|
+
application. Please read the README on https://github.com/abeciana1/rcli_app
|
61
|
+
test_files: []
|