quartet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df871a1266a1a6a40e05b76a7d89766b4c4760b4c161055c169a8f2762f8496d
+  data.tar.gz: af2820266e299556cacf71e0f07afc218a579f1bf4b32ab2e23b823e92f039b3
+SHA512:
+  metadata.gz: 8dd1f79f524a71f43759cf30f9b17187ff272dfa0bd218b70a92282c0aa5978d040cb5a519c2fb2cfbc83470967702ae5885b83659b395deb5a3e81435ec6da8
+  data.tar.gz: 99b0a2c45dbfb63fa09459fdc5443883204c37ca4b499ccd182f6e93e5c19e2aeeb77826b275e66c75192dc1e24ed340c00bf5d89f1f48d96495cabe7e9ac181

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in quartet.gemspec
+gemspec
+
+gem 'rainbow', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    quartet (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rainbow (3.0.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  quartet!
+  rainbow (~> 3.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Cian Guinee
+
+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,18 @@
+# Quartet - Sinatra + ActiveRecord + MySQL + Rake
+A quick start generator for database backed Sinatra apps
+
+## Installation
+Install by running
+`$ gem install quartet`
+
+## Usage
+Run as follows
+`$ quartet <app_name>`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/guineec/quartet.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

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/exe/quartet

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rainbow/refinement'
+require 'quartet'
+
+if ARGV.count < 1
+  puts 'Error! No app name provided'.red
+  exit 11
+end
+
+Quartet.create_app(ARGV[0])

data/lib/quartet.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'quartet/version'
+require 'quartet/builder'
+require 'rainbow/refinement'
+require 'fileutils'
+
+module Quartet
+  using Rainbow
+
+  class Error < StandardError; end
+  class BundlerFailedError < StandardError; end
+
+  def create_app(app_name)
+    puts "Creating #{app_name}...".green
+    print 'Creating directories... '
+    create_directories(app_name)
+    puts '[ DONE ]'.green
+    print 'Building app files... '
+    build_app_files(app_name)
+    puts '[ DONE ]'.green
+    puts 'Running bundler...'
+    Dir.chdir(app_name)
+    output = `bundle`
+    puts output
+    puts "Project #{app_name} created!".green
+    puts 'The following rake tasks are now available...'
+    puts %(
+    rake db:create            # Create the database from DATABASE_URL or config/database.yml for the current Rails.env (use db:create:all to create all dbs in the config)
+    rake db:create_migration  # Create a migration (parameters: NAME, VERSION)
+    rake db:drop              # Drops the database using DATABASE_URL or the current Rails.env (use db:drop:all to drop all databases)
+    rake db:fixtures:load     # Load fixtures into the current environment's database
+    rake db:migrate           # Migrate the database (options: VERSION=x, VERBOSE=false)
+    rake db:migrate:status    # Display status of migrations
+    rake db:rollback          # Rolls the schema back to the previous version (specify steps w/ STEP=n)
+    rake db:schema:dump       # Create a db/schema.rb file that can be portably used against any DB supported by AR
+    rake db:schema:load       # Load a schema.rb file into the database
+    rake db:seed              # Load the seed data from db/seeds.rb
+    rake db:setup             # Create the database, load the schema, and initialize with the seed data (use db:reset to also drop the db first)
+    rake db:structure:dump    # Dump the database structure to db/structure.sql
+    rake db:version           # Retrieves the current schema version number
+    rake serve                # Start the development server
+    rake console              # Start the interactive shell
+  )
+  end
+
+  def create_directories(app_name)
+    base_dir = Dir.getwd
+    app_dir = "#{base_dir}/#{app_name}"
+    FileUtils.mkdir_p(app_dir)
+    %w[config db models public tmp views].each { |dirname| FileUtils.mkdir_p("#{app_dir}/#{dirname}") }
+  end
+
+  def build_app_files(app_name)
+    Gem.find_files('quartet/builders/*.rb').each do |file|
+      file_name = file.split('/')[-1].gsub('.rb', '')
+      require "quartet/builders/#{file_name}"
+
+      file_builder = Kernel.const_get("Quartet::Builders::#{file_name.capitalize}").new
+
+      File.open(file_builder.filepath(app_name), 'w') do |f|
+        f.write(file_builder.build(app_name))
+        f.flush
+      end
+    end
+  end
+
+  module_function :create_app, :create_directories, :build_app_files
+end

data/lib/quartet/builder.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Quartet::Builders
+  class Builder
+    def initialize
+      @directory = ''
+      @file_type = '.rb'
+    end
+
+    def filepath(app_name)
+      unless @name_override
+        return "#{app_name}/#{@directory}/#{underscore(self.class.to_s.split('::')[-1])}#{@file_type}"
+      end
+
+      "#{app_name}/#{@directory}/#{@name_override}#{@file_type}"
+    end
+
+    def underscore(string)
+      string.gsub(/::/, '/')
+            .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+            .tr('-', '_')
+            .downcase
+    end
+
+    def build(app_name); end
+  end
+end

data/lib/quartet/builders/app.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Quartet::Builders
+  class App < Quartet::Builders::Builder
+    def build(_app_name)
+      %{# frozen_string_literal: true
+
+require 'sinatra'
+require 'sinatra/activerecord'
+
+# Require files in models and lib directories
+Dir["./models/*.rb"].each {|file| require file }
+Dir[File.join("./lib", "**/*.rb")].each {|file| require file }
+
+get '/' do
+  erb :welcome
+end
+}
+    end
+  end
+end

data/lib/quartet/builders/config.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Quartet::Builders
+  class Config < Quartet::Builders::Builder
+    def initialize
+      @directory = ''
+      @file_type = '.ru'
+    end
+
+    def build(_app_name)
+      %{# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require
+
+require File.join(File.dirname(__FILE__), 'app.rb')
+run Sinatra::Application
+}
+    end
+  end
+end

data/lib/quartet/builders/database.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Quartet::Builders
+  class Database < Quartet::Builders::Builder
+    def initialize
+      @directory = 'config'
+      @file_type = '.yml'
+    end
+
+    def build(app_name)
+      %(development:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: #{underscore(app_name)}
+  pool: 5
+  username: root
+  password: root
+)
+    end
+  end
+end

data/lib/quartet/builders/gemfile.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Quartet::Builders
+  class Gemfile < Quartet::Builders::Builder
+    def initialize
+      @name_override = "Gemfile"
+      @directory = ''
+      @file_type = ''
+    end
+
+    def build(app_name)
+      %{# frozen_string_literal: true
+
+# Gemfile for #{app_name} generated by Quartet
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/\#{repo_name}" }
+
+# gem "rails"
+
+gem "sinatra", "~> 2.0"
+
+gem "sinatra-activerecord", "~> 2.0"
+
+gem "mysql2", "~> 0.5.3"
+
+gem "rake", "~> 13.0"
+
+gem "irb", "~> 1.2"
+}
+    end
+  end
+end

data/lib/quartet/builders/index.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Quartet::Builders
+  class Index < Quartet::Builders::Builder
+    def initialize
+      @directory = 'public'
+      @file_type = '.html'
+    end
+
+    def build(_app_name)
+      %(<!DOCTYPE html>
+  <html lang="en">
+    <head>
+      <meta charset="UTF-8">
+      <meta name="viewport" content="width=device-width, initial-scale=1.0">
+      <title>Unexpected Error</title>
+      <style>
+        .msg-container {
+          display: flex;
+          flex-direction: column;
+          align-items: center;
+          justify-content: center;
+          width: 100vw;
+          height: 100vh;
+          font-family: arial,sans-serif;
+          color: #333;
+        }
+
+        .header {
+          font-size: 3rem;
+          margin-bottom: 1rem;
+        }
+
+        .message {
+          font-size: 1.2rem;
+          margin-top: 0.3rem;
+        }
+      </style>
+    </head>
+    <body>
+      <div class="msg-container">
+        <h2 class="header">If you're seeing this...</h2>
+        <h4 class="message">Something is wrong!</h4>
+      </div>
+    </body>
+  </html>
+)
+    end
+  end
+end

data/lib/quartet/builders/rakefile.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Quartet::Builders
+  class Rakefile < Quartet::Builders::Builder
+    def initialize
+      @name_override = "Rakefile"
+      @directory = ''
+      @file_type = ''
+    end
+    
+    def build(app_name)
+      %(# frozen_string_literal: true
+
+# Rakefile generated for #{app_name} by Quartet
+# Add tasks as required here
+
+require 'sinatra/activerecord/rake'
+
+namespace :db do
+  task :load_config do
+    require './app'
+  end
+end
+
+task :c do
+  sh 'bundle exec irb -I. -r app.rb'
+end
+
+task :console do
+  sh 'bundle exec irb -I. -r app.rb'
+end
+
+task :serve do
+  sh 'bundle exec rackup config.ru'
+end
+
+task :s do
+  sh 'bundle exec rackup config.ru'
+end
+)
+    end
+  end
+end

data/lib/quartet/builders/readme.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Quartet::Builders
+  class Readme < Quartet::Builders::Builder
+    def initialize
+      @name_override = 'README'
+      @directory = ''
+      @file_type = '.md'
+    end
+
+    def build(app_name)
+      %(# #{app_name}
+Things to include here:
+- A description of your app
+- Instructions for installation/build
+- Instructions for development/running tests etc
+- Licence information
+- ...
+)
+    end
+  end
+end

data/lib/quartet/builders/welcome.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Quartet::Builders
+  class Welcome < Quartet::Builders::Builder
+    def initialize
+      @directory = 'views'
+      @file_type = '.erb'
+    end
+
+    def build(app_name)
+      %(<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>#{app_name}</title>
+  <style>
+    .msg-container {
+      display: flex;
+      flex-direction: column;
+      align-items: center;
+      justify-content: center;
+      width: 100vw;
+      height: 100vh;
+      font-family: arial,sans-serif;
+      color: #333;
+    }
+
+    .header {
+      font-size: 3rem;
+      margin-bottom: 1rem;
+    }
+
+    .message {
+      font-size: 1.2rem;
+      margin-top: 0.3rem;
+    }
+  </style>
+</head>
+<body>
+  <div class="msg-container">
+    <h2 class="header">Quartet executed successfully!</h2>
+    <h4 class="message">Welcome to #{app_name}</h4>
+  </div>åå
+</body>
+</html>
+)
+    end
+  end
+end

data/lib/quartet/version.rb

@@ -0,0 +1,3 @@
+module Quartet
+  VERSION = "0.1.0"
+end

data/quartet.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "quartet/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "quartet"
+  spec.version       = Quartet::VERSION
+  spec.authors       = ["Cian Guinee"]
+  spec.email         = ["cian.guinee@gmail.com"]
+
+  spec.summary       = %q{Sinatra + ActiveRecord + MySQL + Rake}
+  spec.description   = %q{A quick start generator for database backed Sinatra apps}
+  spec.homepage      = "https://github.com/guineec/quartet"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/guineec/quartet"
+    spec.metadata["changelog_uri"] = "https://github.com/guineec/quartet"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: quartet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cian Guinee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A quick start generator for database backed Sinatra apps
+email:
+- cian.guinee@gmail.com
+executables:
+- quartet
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- exe/quartet
+- lib/quartet.rb
+- lib/quartet/builder.rb
+- lib/quartet/builders/app.rb
+- lib/quartet/builders/config.rb
+- lib/quartet/builders/database.rb
+- lib/quartet/builders/gemfile.rb
+- lib/quartet/builders/index.rb
+- lib/quartet/builders/rakefile.rb
+- lib/quartet/builders/readme.rb
+- lib/quartet/builders/welcome.rb
+- lib/quartet/version.rb
+- quartet.gemspec
+homepage: https://github.com/guineec/quartet
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/guineec/quartet
+  source_code_uri: https://github.com/guineec/quartet
+  changelog_uri: https://github.com/guineec/quartet
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Sinatra + ActiveRecord + MySQL + Rake
+test_files: []