setdevenv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97bfc0c8d73609c60cfe013561fc11f2fceaa3c0d95fd3d37320e396b1390cd9
+  data.tar.gz: 0f2677401800a85696ec05ea9eb029d524e8efdfa2d19365b8ff1a224404447c
+SHA512:
+  metadata.gz: c54302279eb6b4484a320e3e007ae0e79b1c92f9197bba47f50be10e222f68b445cb935000d725503ac84712f9fbbcbb7cf6a980f008fc85be3b41e3b853c5bc
+  data.tar.gz: 9ee80bb4304eef46ce4580d01c1ec20d71354ceeb54866fc3950cacde063b1514472e16811bdf62e58aea5e2ff6295a1ce7c5eb6af25e6111a6ddd12cc2c9a9e

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-03
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1 @@
+# Contributor Covenant Code of Conduct

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Júnior
+
+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/README.md

@@ -0,0 +1,26 @@
+# SetDevEnv
+
+A simple gem to create a ruby dev enrionment using docker.
+
+## Install
+
+`gem install setdevenv` or `bundle add setdevenv`
+
+## Usage
+
+```ruby
+setdevenv new example
+```
+
+This command will generate 3 files (***more to comming eventually***) within a folder called `example`.
+
+- Dockerfile.dev
+- docker-compose.yml
+- Makefile
+
+## TODO
+
+- Retrieve ruby/alpine latests version from somewhere (and cache it) 
+- Accept those versions as arguments from cli
+- Accept an argument in cli to use rails when setuping the new environment
+- Accept an argument `--service` to create a custom service within docker-compose

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+task default: :test

data/exe/setdevenv

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/set_dev_env/cli'
+
+SetDevEnv::CLI.start

data/lib/set_dev_env/cli.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'thor'
+require_relative './setup'
+
+module SetDevEnv
+  class CLI < Thor
+    desc 'new project_name', 'generate files to a new project'
+    def new(name)
+      Setup.new(name).build
+    end
+  end
+end

data/lib/set_dev_env/generator/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'thor/group'
+
+module SetDevEnv
+  module Setup::Generator
+    class Base < Thor::Group
+      include Thor::Actions
+
+      def self.source_root
+        "#{File.dirname(__FILE__)}/templates"
+      end
+    end
+  end
+end

data/lib/set_dev_env/generator/docker_compose.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SetDevEnv
+  module Setup::Generator
+    class DockerCompose < Base
+      argument :name, type: :string
+
+      def copy_docker_compose
+        template('docker-compose.tt', "#{name}/docker-compose.yml")
+      end
+    end
+  end
+end

data/lib/set_dev_env/generator/dockerfile.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SetDevEnv
+  module Setup::Generator
+    class Dockerfile < Base
+      argument :name, type: :string
+      argument :alpine_version, type: :string, default: nil, optional: true
+      argument :ruby_version,   type: :string, default: nil, optional: true
+
+      def copy_dockerfile
+        # TODO: retrieve those values from somewhere to take latest ruby/alpine versions
+        self.alpine_version ||= '3.21'
+        self.ruby_version   ||= '3.4.1'
+
+        template('Dockerfile.tt', "#{name}/Dockerfile.dev")
+      end
+    end
+  end
+end

data/lib/set_dev_env/generator/folder.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SetDevEnv
+  module Setup::Generator
+    class Folder < Base
+      argument :name, type: :string
+
+      def create_folder
+        empty_directory(name)
+      end
+    end
+  end
+end

data/lib/set_dev_env/generator/generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SetDevEnv
+  module Setup::Generator
+    require_relative './base'
+    require_relative './folder'
+    require_relative './dockerfile'
+    require_relative './docker_compose'
+    require_relative './makefile'
+
+    def create_folder(name)         = Folder.start([name])
+    def create_dockerfile(name)     = Dockerfile.start([name])
+    def create_docker_compose(name) = DockerCompose.start([name])
+    def create_makefile(name)       = Makefile.start([name])
+  end
+end

data/lib/set_dev_env/generator/makefile.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SetDevEnv
+  module Setup::Generator
+    class Makefile < Base
+      argument :name, type: :string
+
+      def copy_makefile
+        template('Makefile.tt', "#{name}/Makefile")
+      end
+    end
+  end
+end

data/lib/set_dev_env/generator/templates/Dockerfile.tt

@@ -0,0 +1,6 @@
+FROM ruby:<%= ruby_version %>-alpine<%= alpine_version %>
+WORKDIR /<%= name %>
+RUN apk update && apk upgrade
+RUN apk add bash bash-completion build-base tzdata
+
+ENV RUBY_YJIT_ENABLE=1

data/lib/set_dev_env/generator/templates/Makefile.tt

@@ -0,0 +1,3 @@
+bash:
+	@docker compose run --rm --service-ports <%= name %> bash
+	docker compose stop

data/lib/set_dev_env/generator/templates/docker-compose.tt

@@ -0,0 +1,11 @@
+services:
+  <%= name %>:
+    build:
+      context: .
+      dockerfile: Dockerfile.dev
+    volumes:
+      - gems:/usr/local/bundle
+      - .:/<%= name %>
+
+volumes:
+  gems:

data/lib/set_dev_env/setup.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SetDevEnv
+  class Setup
+    require_relative './generator/generator'
+
+    include Generator
+
+    private attr_accessor :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def build
+      create_folder(name)
+      create_dockerfile(name)
+      create_docker_compose(name)
+      create_makefile(name)
+    end
+  end
+end

data/lib/set_dev_env/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SetDevEnv
+  VERSION = '0.1.0'
+end

data/lib/set_dev_env.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'set_dev_env/setup'
+require_relative 'set_dev_env/version'
+
+module SetDevEnv
+  def self.create(name)
+    Setup.new(name).build
+  end
+end

data/sig/set_dev_env.rbs

@@ -0,0 +1,4 @@
+module SetDevEnv
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: setdevenv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Júnior
+bindir: exe
+cert_chain: []
+date: 2025-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+email:
+- b.sep@live.com
+executables:
+- setdevenv
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/setdevenv
+- lib/set_dev_env.rb
+- lib/set_dev_env/cli.rb
+- lib/set_dev_env/generator/base.rb
+- lib/set_dev_env/generator/docker_compose.rb
+- lib/set_dev_env/generator/dockerfile.rb
+- lib/set_dev_env/generator/folder.rb
+- lib/set_dev_env/generator/generator.rb
+- lib/set_dev_env/generator/makefile.rb
+- lib/set_dev_env/generator/templates/Dockerfile.tt
+- lib/set_dev_env/generator/templates/Makefile.tt
+- lib/set_dev_env/generator/templates/docker-compose.tt
+- lib/set_dev_env/setup.rb
+- lib/set_dev_env/version.rb
+- sig/set_dev_env.rbs
+homepage: https://github.com/b-sep/setdevenv
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/b-sep/setdevenv
+  source_code_uri: https://github.com/b-sep/setdevenv
+  changelog_uri: https://github.com/b-sep/setdevenv/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.5
+specification_version: 4
+summary: A simple gem to setup a basic ruby development environment using docker/docker-compose
+test_files: []