bruw 0.1.1

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at 26109239+Quentinchampenois@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bruw.gemspec
+gemspec
+
+gem "byebug"
+gem "colorize"
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rubocop"
+gem "tty-prompt"

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    bruw (0.1.1)
+      thor
+      tty-prompt
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    colorize (0.8.1)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.11.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    thor (1.1.0)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.0)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    unicode-display_width (2.0.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bruw!
+  bundler (>= 1.0.0)
+  byebug
+  colorize
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop
+  tty-prompt
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 quentinchampenois
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,27 @@
+.DEFAULT_GOAL := build
+
+NAME=bruw-0.1.1.gem
+
+install:
+	bundle install
+
+install_pkg:
+	gem install pkg/$(NAME)
+
+rake_build:
+	bundle exec rake build
+
+build:
+	@make install
+	@make rake_build
+	@make install_pkg
+
+cucumber:
+	bundle exec cucumber features/*.features
+
+rspec:
+	bundle exec rspec spec
+
+tests:
+	@make cucumber
+	@make rspec

data/README.md

@@ -0,0 +1,51 @@
+# Bruw
+
+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/bruw`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bruw'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bruw
+
+Install gem locally using Makefile
+
+    $ make 
+    
+If you use rbenv and you want to install it for several version, you will have to switch ruby version first
+
+    $ rbenv local [VERSION] && make
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bruw. 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]/bruw/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Bruw project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bruw/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bruw"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bruw.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/bruw/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bruw"
+  spec.version       = Bruw::VERSION
+  spec.authors       = ["quentinchampenois"]
+  spec.email         = ["26109239+Quentinchampenois@users.noreply.github.com"]
+
+  spec.summary       = 'Simple CLI for daily tasks'
+  spec.description   = 'Bruw is a CLI designed to simplify daily tasks'
+  spec.homepage      = 'https://github.com/quentinchampenois/bruw'
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = 'https://github.com/quentinchampenois/bruw'
+
+  spec.add_development_dependency "bundler", ">= 1.0.0"
+  spec.add_development_dependency "rspec", "~> 2.6"
+
+  spec.add_dependency "thor"
+  spec.add_dependency "tty-prompt"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/docs/how_to_add_subcommand.md

@@ -0,0 +1,108 @@
+# Add a subcommand to Bruw
+
+All gem's logic is located under `lib/` folder. 
+
+For now there is no generator, but it could be an interesting feature. Furthermore, maybe the gem structure will change because I am not persuaded by the current structure. 
+
+## Getting started
+
+Let's imagine we create the subcommand `toto`.
+
+### Create library
+
+First of all, I define the dedicated library for the `toto` logic.
+
+    $ touch lib/bruw/toto.rb
+
+In `toto.rb`, I define the core of my library to be used in the following subcommand.
+
+```
+#lib/bruw/toto.rb
+# frozen_string_literal: true
+
+module Bruw
+  class Toto
+    def self.my_name_is
+      "My name is Toto"
+    end
+  end
+end
+```
+
+### Create subcommand
+
+Then you can create the wanted subcommand under `lib/bruw/commands/` as following
+
+    $ touch lib/bruw/commands/toto.rb
+    
+And insert the Thor command you want
+
+```
+#lib/bruw/commands/toto.rb
+# frozen_string_literal: true
+
+require 'thor'
+
+module Bruw
+  module Commands
+    class Toto < Thor
+      desc "name", "Returns my current name"
+      long_desc <<-LONGDESC
+        Returns the current name
+      LONGDESC
+      def name
+        puts Bruw::Toto.my_name_is
+      end
+    end
+  end
+end
+```
+
+### Register the library and subcommand
+
+Now you can add your library to the current command
+
+Add the following `require` to the file `lib/bruw.rb`
+```
+require "bruw/toto"
+require "bruw/commands/toto"
+```
+
+And the create your new subcommand in `lib/bruw/cli.rb`
+
+```
+#lib/bruw/cli.rb
+# frozen_string_literal: true
+
+require "bruw"
+
+module Bruw
+  class CLI < Thor
+    desc "version", "Get the current cli version"
+    def version
+      puts VERSION
+    end
+
+    desc "toto SUBCOMMAND ...ARGS", "Simple toto subcommand !"
+    subcommand "toto", Bruw::Commands::Toto
+  end
+end
+```
+
+## Congratulations !
+
+You should now be able to run the command `bundle exec exe/bruw toto name` !
+
+Example : 
+
+```
+    $ bundle exec exe/bruw toto name
+    output: My name is Toto
+```
+
+## More information
+
+You can install the gem without publishing it nor make a new release if you want to test the command line from outside project. To do so, just install the gem locally, for example 
+
+    $ make
+    

data/docs/ideas.md

@@ -0,0 +1,19 @@
+# Commands that could be implemented in CLI
+
+- [ ] Open current project's git repository in browser
+
+- [ ] Create new PR from current branch
+
+- [ ] heck ports (rails, redis, postgresql, etc) and kill
+
+- [ ] Curl file from specific decidim version and save it in current project
+
+- [ ] Check which files needs to be bumped (diff between local files and rawgithubcontent)
+
+- [ ] Create generator of subcommands
+
+- [ ] Clear all remote for a given repository
+
+- [ ] Fetch all remote
+
+- [ ] Add new remote and fetch repo

data/docs/testing.md

@@ -0,0 +1,23 @@
+# Testing bruw gem
+
+Bruw command is tested using [Rspec](https://github.com/rspec/rspec) and [Aruba](https://github.com/cucumber/aruba)
+
+## Functional tests
+
+Functional tests are defined under `features` folder. To run this tests, use `cucumber` gem as following : 
+
+```sh
+bundle exec cucumber features/bruw.features
+``` 
+
+## Unit tests
+
+Unit tests are defined under `spec` folder. There defined to work with `rspec` gem.
+
+To run tests with rspec, use `rspec` as following: 
+
+```sh
+bundle exec rspec spec
+```
+
+

data/exe/bruw

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bruw/cli"
+Bruw::CLI.start

data/lib/bruw/base.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Bruw
+  class Base
+    def self.version
+      "0.0.1"
+    end
+
+    def self.strip_path(path)
+      return if path.nil? || path.empty?
+      return path[0..-2] if path.end_with? "/"
+
+      path
+    end
+
+    def self.create_path(path)
+      return if Dir.exist?(path)
+
+      FileUtils.mkpath(path)
+    end
+  end
+end

data/lib/bruw/cli.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "bruw"
+
+module Bruw
+  class CLI < Thor
+    desc "version", "Get the current cli version"
+    def version
+      puts VERSION
+    end
+
+    desc "zip TARGET DESTINATION", "Compress target"
+    option :tar, required: false, banner: "Use tar, zip by default", aliases: "-t", type: :boolean, default: false
+    def zip(target, destination = ".")
+      target = Bruw::Base.strip_path(target)
+      dest = Bruw::Base.strip_path(destination)
+      extension = if options[:tar]
+                    "tar.gz"
+                  else
+                    "zip"
+                  end
+      final = "#{dest}/#{target}.#{extension}"
+
+      raise StandardError, "File already existing : #{final}" if File.exist?(final)
+
+      Bruw::Base.create_path(dest) unless Dir.exist?(dest)
+
+      `tar -zcf #{final} #{target}` if options[:tar]
+      `zip -r #{final} #{target}` unless options[:tar]
+
+      puts "Compression finished !".colorize(:green)
+      puts "> #{final}"
+    rescue StandardError => e
+      puts e.message.colorize(:red)
+    end
+
+    desc "unzip TARGET", "Decompress and unpack target"
+    option :zip, required: false, banner: "Force decompression with zip", aliases: "-z", type: :boolean, default: false
+    option :tar, required: false, banner: "Force decompression with tar", aliases: "-t", type: :boolean, default: false
+    def unzip(target)
+      raise StandardError, "File '#{target}' does not exists" unless File.exist?(target)
+
+      if target.end_with?(".zip") || options[:zip]
+        `unzip #{target}`
+      elsif target.end_with?(".tar.gz") || options[:tar]
+        `tar -zxf #{target}`
+      else
+        raise StandardError, "Unknown tool to use"
+      end
+
+      puts "Decompression finished !".colorize(:green)
+    rescue StandardError => e
+      puts e.message.colorize(:red)
+    end
+
+    desc "decidim SUBCOMMAND ...ARGS", "Manage Decidim projects"
+    subcommand "decidim", Bruw::Commands::Decidim
+
+    desc "git SUBCOMMAND ...ARGS", "Manage Git projects"
+    subcommand "git", Bruw::Commands::Git
+  end
+end

data/lib/bruw/commands/decidim.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "thor"
+require "net/http"
+
+module Bruw
+  module Commands
+    class Decidim < Thor
+      desc "version", "Get the current decidim version"
+      long_desc <<-LONGDESC
+        Checks the Decidim version for the current project based on the bundler gem infos
+      LONGDESC
+      def version
+        puts "Current Decidim version is #{Bruw::Decidim.version&.colorize(:green)}"
+      rescue StandardError => e
+        puts e.message.colorize(:red)
+      end
+
+      desc "curl [RELATIVE_PATH]", "Curl given file against target github repository"
+      long_desc <<-LONGDESC
+        Allows to curl source code of specified path for a given version
+      LONGDESC
+      option :tag, required: false, banner: "Tag must have format vx.xx.x : Default current decidim version",
+                   aliases: "-t", type: :string
+      option :branch, required: false, banner: "Remote branch to curl",
+                   aliases: "-b", type: :string
+      option :owner, required: false, banner: "Owner name : Default 'decidim'", aliases: "-o", type: :string
+      option :repo, required: false, banner: "Repository name : Default 'decidim'", aliases: "-r", type: :string
+      option :save, required: false, banner: "Save output in relative path", aliases: "-s", type: :boolean
+      def curl(path)
+        options[:path] = path
+        options[:version] = find_version_for_curl options
+
+        response = Bruw::Decidim.curl(options)
+
+        if options[:save]
+          path = strip_path(path)
+          create_path(path)
+          save_file(path, response.chop)
+
+          puts "Curl finished, please see '#{path}'".colorize(:green)
+        else
+          puts response.chop
+        end
+      rescue StandardError => e
+        puts e.message.colorize(:red)
+      end
+
+      private
+
+      def save_file(path, content)
+        File.open(path, "w") do |f|
+          f.puts content
+        end
+
+        puts "File '#{path}' created.".colorize(:green)
+      end
+
+      def create_path(path)
+        return if Dir.exist?(path)
+
+        FileUtils.mkpath(File.dirname(path))
+      end
+
+      def strip_path(path)
+        return path unless Bruw::Decidim.osp_app?
+
+        path.split("/")[1..].join("/")
+      end
+
+      def find_version_for_curl(options)
+        if !options[:branch].nil? && !options[:branch].empty?
+          options[:branch]
+        elsif !options[:tag].nil? && !options[:tag].empty?
+          return options[:tag] if options[:tag].start_with?("v")
+
+          "v#{options[:tag]}"
+        else
+          "v#{Bruw::Decidim.version}"
+        end
+      end
+    end
+  end
+end