sinatra-scaffold 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 883999ffd637e6d03bbe1e9e935637b1e52618bacce8e8f38d2a2bb682fc4ff6
+  data.tar.gz: ef5429ea137c387f8b282143ab17088c6bedf7acbcef19f13e33c88a655cb8b8
+SHA512:
+  metadata.gz: b2c908960db471de3b446628ae45dc770c566bc029b0853c5b345ded512035d53ee5c93a826e88e11a823aac9e425a7ade391044c6d6bd3b13be977498c1ac69
+  data.tar.gz: 5967b5fba83756ae2fd97d4c00a3c23322dc362f2a003b58337103ccc3f9cddbf4b374bd155217ca7c3e579ab3c2a0d36c86c44640dd7610f32bf2149b2607a6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-16
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+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.
+
+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.
+
+## Scope
+
+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 email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**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.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**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.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**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.
+
+### 4. Permanent Ban
+
+**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.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/README.md

@@ -0,0 +1,51 @@
+# SinatraScaffold
+
+A scaffold cli for the Sinatra web gem.
+
+## Installation
+
+Globally install
+```sh
+gem install sinatra-scaffold
+```
+
+Project install
+```sh
+bundle add sinatra-scaffold
+```
+
+## Usage
+
+```sh
+sinatra-scaffold new my_app
+```
+
+## Development
+
+Install the dependencies
+```sh
+bundle install
+```
+
+Build and install gem locally
+
+```sh
+gem build sinatra-scaffold.gemspec && gem install ./sinatra-scaffold-0.1.0.gem
+```
+
+Run lint
+```sh
+bundle exec rake standard:fix
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joaoGabriel55/sinatra-scaffold. 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/joaoGabriel55/sinatra-scaffold/blob/main/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 SinatraScaffold project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joaoGabriel55/sinatra-scaffold/blob/main/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sinatra-scaffold"
+
+# 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.
+
+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/bin/sinatra-scaffold

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'sinatra_scaffold'
+
+SinatraScaffold::CLI.start

data/lib/sinatra_scaffold/cli.rb

@@ -0,0 +1,185 @@
+require "thor"
+require "fileutils"
+
+module SinatraScaffold
+  class CLI < Thor
+    desc "new APP_NAME", "Create a new Sinatra application with a basic scaffold"
+    def new(app_name)
+      create_directory_structure(app_name)
+      create_main_files(app_name)
+      puts "Sinatra application #{app_name} created successfully!"
+    end
+
+    private
+
+    def create_directory_structure(app_name)
+      directories = [
+        "#{app_name}/app",
+        "#{app_name}/app/routes",
+        "#{app_name}/spec",
+        "#{app_name}/spec/requests"
+      ]
+
+      directories.each do |dir|
+        FileUtils.mkdir_p(dir)
+      end
+    end
+
+    def create_main_files(app_name)
+      File.write("#{app_name}/config.ru", <<~RUBY)
+        require "./app"
+
+        run Sinatra::Application
+      RUBY
+
+      File.write("#{app_name}/app/routes/users_routes.rb", <<~RUBY)
+        require "sinatra/base"
+
+        get "/users" do
+          ["User 1", "User 2"].to_json
+        end
+      RUBY
+
+      File.write("#{app_name}/server.rb", <<~RUBY)
+        require "sinatra"
+        require "sinatra/base"
+        require "dotenv"
+
+        Dotenv.load
+
+        set :bind, "0.0.0.0"
+        set :default_content_type, :json
+
+        require "./app/routes/users_routes"
+
+        get "/health-check" do
+          {status: "ok"}.to_json
+        end
+      RUBY
+
+      File.write("#{app_name}/.gitignore", <<~RUBY)
+        .env
+      RUBY
+
+      File.write("#{app_name}/spec/spec_helper.rb", <<~RUBY)
+        # frozen_string_literal: true
+
+        ENV["RACK_ENV"] = "test"
+
+        require "rubygems"
+        require "bundler"
+
+        require_relative "../server"
+
+        Bundler.require(:default)                   # load all the default gems
+        Bundler.require(Sinatra::Base.environment)  # load all the environment specific gems
+
+        Dotenv.load
+
+        def app
+          Sinatra::Application
+        end
+
+        RSpec.configure do |config|
+          config.include Rack::Test::Methods
+          config.expect_with :rspec do |expectations|
+            expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+          end
+          config.mock_with :rspec do |mocks|
+            mocks.verify_partial_doubles = true
+          end
+          config.filter_run :focus
+          config.run_all_when_everything_filtered = true
+          config.disable_monkey_patching!
+          config.warnings = true
+          config.default_formatter = "doc" if config.files_to_run.one?
+          config.profile_examples = 10
+          config.order = :random
+          Kernel.srand config.seed
+        end
+      RUBY
+
+      File.write("#{app_name}/spec/requests/users_spec.rb", <<~RUBY)
+        require "spec_helper"
+
+        RSpec.describe "GET /users" do
+          it "returns a list of users" do
+            get "/users"
+
+            expect(last_response).to be_ok
+            expect(last_response.body).to eq(["User 1", "User 2"].to_json)
+          end
+        end
+      RUBY
+
+      File.write("#{app_name}/spec/requests/health_check_spec.rb", <<~RUBY)
+        require "spec_helper"
+
+        RSpec.describe "GET /health-check" do
+          it "returns ok" do
+            get "/health-check"
+
+            expect(last_response).to be_ok
+            expect(last_response.body).to eq({status: "ok"}.to_json)
+          end
+        end
+      RUBY
+
+      File.write("#{app_name}/Gemfile", <<~RUBY)
+        source "https://rubygems.org"
+
+        gem "sinatra"
+        gem "dotenv"
+        gem "rake"
+
+        group :test do
+          gem "rack-test"
+          gem "rspec"
+        end
+
+        group :development, :test do
+          gem "pry"
+          gem "standard"
+        end
+      RUBY
+
+      File.write("#{app_name}/Rakefile", <<~RUBY)
+        require "rspec/core/rake_task"
+
+        RSpec::Core::RakeTask.new(:spec)
+
+        require "standard/rake"
+
+        task default: %i[spec standard]
+      RUBY
+
+      File.write("#{app_name}/README.md", <<~RUBY)
+        # #{app_name}
+
+        My Sinatra application
+
+        ## Running
+        Run:
+        ```sh
+        ruby server.rb
+        ```
+
+        ## Testing
+        Run:
+        ```sh
+        bundle exec rspec
+        bundle exec rspec [file-or-directory-path]
+        ```
+
+        ## Lint
+        ```sh
+        bundle exec rake standard
+        ```
+        Lint and fix with:
+        ```sh
+        bundle exec rake standard:fix
+        ```
+      RUBY
+    end
+  end
+end

data/lib/sinatra_scaffold/version.rb

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

data/lib/sinatra_scaffold.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "sinatra_scaffold/cli"
+require "sinatra_scaffold/version"
+
+module SinatraScaffold
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-scaffold
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- joaoGabriel55
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Ruby gem to make more easy the getting start of web app development with
+  Sinatra gem
+email:
+- joaoGabriel55
+executables:
+- sinatra-scaffold
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- bin/console
+- bin/setup
+- bin/sinatra-scaffold
+- lib/sinatra_scaffold.rb
+- lib/sinatra_scaffold/cli.rb
+- lib/sinatra_scaffold/version.rb
+homepage: https://github.com/joaoGabriel55/sinatra-scaffold
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/joaoGabriel55/sinatra-scaffold
+  source_code_uri: https://github.com/joaoGabriel55/sinatra-scaffold
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Scaffold for Sinatra applications
+test_files: []