ddenv 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: d454d9e8eba496ccf1c073109663cd75eb360317650505ba195f46e35df21330
4
+ data.tar.gz: ed0c07ba499cdb8ebbfdb0c24d4d57c64902eb4e5ec50599bed07c97961b1dff
5
+ SHA512:
6
+ metadata.gz: bd6afc63047346551aee1dbea9d9b29895e3f355dbbdfb3638fea312aa05daa658af804b282b6f9ac36d7d0b6b95849162bbbbec881dcd07e863c141aba33d91
7
+ data.tar.gz: 3302364fce3c5cfee447a1cffecbf2ed5f691f1821e2b9db8a0a38ae362800cec2b8e0df7dc9f4bae28234ec2ee39c1eaa29f842cc2a7fd473ab09ee60f93584
data/.rubocop.yml ADDED
@@ -0,0 +1,16 @@
1
+ AllCops:
2
+ TargetRubyVersion: 3.3
3
+ NewCops: disable
4
+ SuggestExtensions: false
5
+
6
+ Style/StringLiterals:
7
+ EnforcedStyle: double_quotes
8
+
9
+ Style/StringLiteralsInInterpolation:
10
+ EnforcedStyle: double_quotes
11
+
12
+ Style/Documentation:
13
+ Enabled: false
14
+
15
+ Metrics:
16
+ Enabled: false
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ 3.3.0
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ ## [Unreleased]
2
+
3
+ ## [0.1.0] - 2024-04-28
4
+
5
+ - Initial release
@@ -0,0 +1,84 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8
+
9
+ ## Our Standards
10
+
11
+ Examples of behavior that contributes to a positive environment for our community include:
12
+
13
+ * Demonstrating empathy and kindness toward other people
14
+ * Being respectful of differing opinions, viewpoints, and experiences
15
+ * Giving and gracefully accepting constructive feedback
16
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
+ * Focusing on what is best not just for us as individuals, but for the overall community
18
+
19
+ Examples of unacceptable behavior include:
20
+
21
+ * The use of sexualized language or imagery, and sexual attention or
22
+ advances of any kind
23
+ * Trolling, insulting or derogatory comments, and personal or political attacks
24
+ * Public or private harassment
25
+ * Publishing others' private information, such as a physical or email
26
+ address, without their explicit permission
27
+ * Other conduct which could reasonably be considered inappropriate in a
28
+ professional setting
29
+
30
+ ## Enforcement Responsibilities
31
+
32
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
33
+
34
+ Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
35
+
36
+ ## Scope
37
+
38
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
39
+
40
+ ## Enforcement
41
+
42
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at git@denisdefreyne.com. All complaints will be reviewed and investigated promptly and fairly.
43
+
44
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
45
+
46
+ ## Enforcement Guidelines
47
+
48
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
49
+
50
+ ### 1. Correction
51
+
52
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
53
+
54
+ **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
55
+
56
+ ### 2. Warning
57
+
58
+ **Community Impact**: A violation through a single incident or series of actions.
59
+
60
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
61
+
62
+ ### 3. Temporary Ban
63
+
64
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
65
+
66
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
67
+
68
+ ### 4. Permanent Ban
69
+
70
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
71
+
72
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
73
+
74
+ ## Attribution
75
+
76
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
77
+ available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
78
+
79
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
80
+
81
+ [homepage]: https://www.contributor-covenant.org
82
+
83
+ For answers to common questions about this code of conduct, see the FAQ at
84
+ https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2024 Denis Defreyne
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
13
+ all 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
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,39 @@
1
+ # Ddenv
2
+
3
+ TODO: Delete this and the text below, and describe your gem
4
+
5
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ddenv`. To experiment with that code, run `bin/console` for an interactive prompt.
6
+
7
+ ## Installation
8
+
9
+ TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
10
+
11
+ Install the gem and add to the application's Gemfile by executing:
12
+
13
+ $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
14
+
15
+ If bundler is not being used to manage dependencies, install the gem by executing:
16
+
17
+ $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
18
+
19
+ ## Usage
20
+
21
+ TODO: Write usage instructions here
22
+
23
+ ## Development
24
+
25
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
26
+
27
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
28
+
29
+ ## Contributing
30
+
31
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ddenv. 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/[USERNAME]/ddenv/blob/main/CODE_OF_CONDUCT.md).
32
+
33
+ ## License
34
+
35
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
36
+
37
+ ## Code of Conduct
38
+
39
+ Everyone interacting in the Ddenv project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ddenv/blob/main/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ require "minitest/test_task"
5
+
6
+ Minitest::TestTask.create
7
+
8
+ require "rubocop/rake_task"
9
+
10
+ RuboCop::RakeTask.new
11
+
12
+ task default: %i[test rubocop]
data/dev.yml ADDED
@@ -0,0 +1,4 @@
1
+ up:
2
+ - homebrew: vim
3
+ - homebrew: font-roboto
4
+ - homebrew: font-roboto-mono
data/exe/ddenv ADDED
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ require "ddenv"
5
+
6
+ Ddenv::CLI.new(ARGV).call
data/lib/ddenv/cli.rb ADDED
@@ -0,0 +1,27 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Ddenv
4
+ class CLI
5
+ def initialize(args)
6
+ @args = args
7
+ end
8
+
9
+ def call
10
+ if @args.size != 1
11
+ warn "usage: ddenv [command]"
12
+ exit 64 # EX_USAGE
13
+ end
14
+
15
+ command_name = @args.first
16
+ case command_name
17
+ when "help"
18
+ Ddenv::Commands::Help.new.call
19
+ when "up"
20
+ Ddenv::Commands::Up.new.call
21
+ else
22
+ warn "ddenv: unknown command: #{command_name}"
23
+ exit 64 # EX_USAGE
24
+ end
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Ddenv
4
+ class Command
5
+ def call
6
+ raise SubclassResponsibilityError.new(self.class, __method__)
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Ddenv
4
+ module Commands
5
+ class Help < Ddenv::Command
6
+ def call
7
+ # TODO
8
+ puts "ddenv help goes here…"
9
+ end
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,24 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Ddenv
4
+ module Commands
5
+ class Up < Ddenv::Command
6
+ def call
7
+ config = Ddenv::Config.read_from_file("dev.yml")
8
+
9
+ config.goals.each do |goal|
10
+ puts goal.message
11
+ puts " Checking..."
12
+ if goal.achieved?
13
+ puts " Already achieved."
14
+ else
15
+ puts " Achieving..."
16
+ goal.achieve
17
+ puts " Newly achieved."
18
+ end
19
+ puts
20
+ end
21
+ end
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,33 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Ddenv
4
+ class Config
5
+ def initialize(hash)
6
+ @hash = hash
7
+ end
8
+
9
+ def self.read_from_file(filename)
10
+ new(YAML.safe_load(File.read(filename)))
11
+ end
12
+
13
+ def goals
14
+ up = @hash.fetch("up", [])
15
+
16
+ up.map do |element|
17
+ key, value =
18
+ case element
19
+ when Hash
20
+ [element.keys.first, element.values.first]
21
+ when String
22
+ # TODO: for later
23
+ # (when a goal has no extra details)
24
+ end
25
+
26
+ case key
27
+ when "homebrew"
28
+ Goals::HomebrewPackageInstalled.new(value)
29
+ end
30
+ end
31
+ end
32
+ end
33
+ end
data/lib/ddenv/goal.rb ADDED
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Ddenv
4
+ class Goal
5
+ def initialize; end
6
+
7
+ def message
8
+ raise SubclassResponsibilityError.new(self.class, __method__)
9
+ end
10
+
11
+ def achieved?
12
+ raise SubclassResponsibilityError.new(self.class, __method__)
13
+ end
14
+
15
+ def achieve
16
+ raise SubclassResponsibilityError.new(self.class, __method__)
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Ddenv
4
+ module Goals
5
+ class HomebrewPackageInstalled < Goal
6
+ def initialize(package_name)
7
+ super()
8
+ @package_name = package_name
9
+ end
10
+
11
+ def message
12
+ "Installing Homebrew package #{@package_name}"
13
+ end
14
+
15
+ def achieved?
16
+ Homebrew.package_installed?(@package_name)
17
+ end
18
+
19
+ def achieve
20
+ # TODO: use :pretty when passing --verbose
21
+ cmd = TTY::Command.new(printer: :null)
22
+ cmd.run("brew", "install", @package_name)
23
+ end
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Ddenv
4
+ module Homebrew
5
+ module_function
6
+
7
+ def package_installed?(package_name)
8
+ # TODO: use :pretty when passing --verbose
9
+ cmd = TTY::Command.new(printer: :null)
10
+
11
+ stdout, _stderr = cmd.run("brew", "info", "--json", package_name)
12
+ info = JSON.parse(stdout)
13
+
14
+ !info[0].fetch("installed").empty?
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Ddenv
4
+ class SubclassResponsibilityError < StandardError
5
+ def initialize(klass, method_name)
6
+ super("Subclasses of #{klass} must implement the ##{method_name} method.")
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Ddenv
4
+ VERSION = "0.1.0"
5
+ end
data/lib/ddenv.rb ADDED
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "json"
4
+ require "yaml"
5
+
6
+ require "tty-command"
7
+
8
+ require_relative "ddenv/cli"
9
+ require_relative "ddenv/command"
10
+ require_relative "ddenv/config"
11
+ require_relative "ddenv/goal"
12
+ require_relative "ddenv/homebrew"
13
+ require_relative "ddenv/subclass_responsibility_error"
14
+ require_relative "ddenv/version"
15
+
16
+ require_relative "ddenv/commands/help"
17
+ require_relative "ddenv/commands/up"
18
+
19
+ require_relative "ddenv/goals/homebrew_package_installed"
metadata ADDED
@@ -0,0 +1,82 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: ddenv
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Denis Defreyne
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2024-04-29 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: tty-command
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '0.10'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.10'
27
+ description: Creates and maintains an environment for local development, including
28
+ Ruby and Node versions.
29
+ email:
30
+ - git@denisdefreyne.com
31
+ executables:
32
+ - ddenv
33
+ extensions: []
34
+ extra_rdoc_files: []
35
+ files:
36
+ - ".rubocop.yml"
37
+ - ".ruby-version"
38
+ - CHANGELOG.md
39
+ - CODE_OF_CONDUCT.md
40
+ - LICENSE.txt
41
+ - README.md
42
+ - Rakefile
43
+ - dev.yml
44
+ - exe/ddenv
45
+ - lib/ddenv.rb
46
+ - lib/ddenv/cli.rb
47
+ - lib/ddenv/command.rb
48
+ - lib/ddenv/commands/help.rb
49
+ - lib/ddenv/commands/up.rb
50
+ - lib/ddenv/config.rb
51
+ - lib/ddenv/goal.rb
52
+ - lib/ddenv/goals/homebrew_package_installed.rb
53
+ - lib/ddenv/homebrew.rb
54
+ - lib/ddenv/subclass_responsibility_error.rb
55
+ - lib/ddenv/version.rb
56
+ homepage: https://github.com/denisdefreyne/ddenv
57
+ licenses:
58
+ - MIT
59
+ metadata:
60
+ homepage_uri: https://github.com/denisdefreyne/ddenv
61
+ source_code_uri: https://github.com/denisdefreyne/ddenv
62
+ changelog_uri: https://github.com/denisdefreyne/ddenv/blob/main/NEWS.md
63
+ post_install_message:
64
+ rdoc_options: []
65
+ require_paths:
66
+ - lib
67
+ required_ruby_version: !ruby/object:Gem::Requirement
68
+ requirements:
69
+ - - "~>"
70
+ - !ruby/object:Gem::Version
71
+ version: '3.3'
72
+ required_rubygems_version: !ruby/object:Gem::Requirement
73
+ requirements:
74
+ - - ">="
75
+ - !ruby/object:Gem::Version
76
+ version: '0'
77
+ requirements: []
78
+ rubygems_version: 3.5.9
79
+ signing_key:
80
+ specification_version: 4
81
+ summary: Manage local developer environment
82
+ test_files: []