frankly 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93bc4a74b8e4c574817e4e8cd0de16112b5c6d152fcc39dfbb641d34c9cb9f6f
-  data.tar.gz: 58589529b0b9450e534e1018fe75ef07bc708c095abca661d832fb7e7c84d4dd
+  metadata.gz: fe3e14e6b7eaca34d9ce4bfbb3b8ecd42ee953945747ea7d2cdb29e968b5cb4e
+  data.tar.gz: 5d03218e4e887f6a4830ab7050f1131c8a56fa5725802e26661f5849b7a0da90
 SHA512:
-  metadata.gz: 95420fbfd186664fc392594e6ea60a4a460aaed358678f08ac86af854818524c22eae51830df580309e2a437370c70feb3dd8f935fd65e7b66e66fb877254e32
-  data.tar.gz: a96eb3ff588b6cb6e8a111f7c634d0d4ceafb64856c86cd459f6ab78ac590f60ac8ac032fdbf896c8127dc4a4167e5f417147ac7b762ab20115dc56a06b1fa4c
+  metadata.gz: 67fd2432d06b7846926d09794e661362d04b51901789d267bd43370377f5598c90f2e736a454cb7483b3fb98eeff36f594d2133b78e4f14c4781f2a97a76dd72
+  data.tar.gz: 788e5b29b4ff3a5ea7eba2b4a5c7fe051a51623a0860c02ca5cf9233b5cd1be579c99f505a035abf4e6eaf2fddec556f14c4cb62a85f30c75440a8b5c725c35a

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.1", "3.2", "3.3"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run specs
+        run: bundle exec rspec

data/README.md

@@ -1,8 +1,8 @@
 # Frankly
 
-`frankly` is a Sinatra starter generator.
+`frankly` is a small Thor-based Sinatra scaffold generator.
 
-It creates a PostgreSQL + ActiveRecord app scaffold with a modern Sinatra setup.
+It creates a PostgreSQL + ActiveRecord app with a minimal RSpec setup.
 
 ## Requirements
 
@@ -18,13 +18,11 @@ gem install frankly
 
 ## Usage
 
-Generate a new app:
-
 ```sh
 frankly my_app
 ```
 
-### Options
+Common options:
 
 ```sh
 frankly my_app --bundle
@@ -34,7 +32,32 @@ frankly my_app --skip-git
 - `--bundle`: runs `bundle install` in the generated app
 - `--skip-git`: skips `git init`
 
-## Generated app quickstart
+## What It Generates
+
+```text
+my_app/
+  app.rb
+  config.ru
+  Gemfile
+  Rakefile
+  config/
+    environment.rb
+    database.rb
+  app/views/
+    layout.erb
+    index.erb
+  spec/
+    spec_helper.rb
+    requests/app_spec.rb
+```
+
+## Name and DB Naming Behavior
+
+- The generated folder keeps your requested name (downcased), including hyphens.
+- Default database names are PostgreSQL-friendly and use underscores.
+- Example: `frankly my-app` creates `my-app/`, with default DB names like `my_app_development`.
+
+## Generated App Quickstart
 
 ```sh
 cd my_app
@@ -42,7 +65,14 @@ bundle install
 bundle exec rackup
 ```
 
-Open http://localhost:9292.
+Open [http://localhost:9292](http://localhost:9292).
+
+## Troubleshooting
+
+- PostgreSQL not running:
+  - Start Postgres and set `DATABASE_URL`, then run `bundle exec rake db:create db:migrate`.
+- Port already in use (`9292`):
+  - Run on another port, e.g. `bundle exec rackup -p 9393`.
 
 ## Development (this gem)
 
@@ -51,19 +81,6 @@ bin/setup
 bundle exec rspec
 ```
 
-## Release
-
-```sh
-bundle exec rake build
-bundle exec rake install
-bundle exec rake release
-```
-
-## Contributing
-
-Issues and pull requests are welcome at:
-https://github.com/kenrett/frankly
-
 ## License
 
 MIT. See [LICENSE.txt](LICENSE.txt).

data/bin/console

@@ -3,7 +3,7 @@
 
 ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
 require "bundler/setup"
-require_relative "../config/environment"
+require "frankly"
 
 begin
   require "pry"

data/bin/frankly

@@ -1,10 +1,11 @@
 #!/usr/bin/env ruby
-require 'rubygems'
-require 'bundler/setup'
-require 'frankly'
+require "rubygems"
+require "bundler/setup"
+require "frankly"
 
 begin
-  require 'frankly/cli'
+  puts Frankly::Banner::ASCII_ART
+  require "frankly/cli"
   Frankly::CLI.start
 rescue Interrupt => e
   puts "\nQuitting..."

data/frankly.gemspec

@@ -3,6 +3,7 @@
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "frankly/version"
+require "frankly/banner"
 
 Gem::Specification.new do |spec|
   spec.name = "frankly"
@@ -15,20 +16,8 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/kenrett/frankly"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.1"
-  spec.post_install_message = <<-PIC
-              .
-  .---------.'---.
-  '.       :    .'
-    '.  .:::  .' The Chairman
-      '.'::'.'    of the Board
-        '||'       has arrived.
-         ||
-         ||
-         ||
-     ---====---
-       PIC
+  spec.post_install_message = Frankly::Banner::ASCII_ART
 
-  spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.start_with?("spec/") }

data/lib/frankly/banner.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Frankly
+  module Banner
+    ASCII_ART = <<~ART
+                .
+      .---------.'---.
+      '.       :    .'
+        '.  .:::  .' The Chairman
+          '.'::'.'    of the Board
+            '||'       has arrived.
+             ||
+             ||
+             ||
+         ---====---
+    ART
+  end
+end

data/lib/frankly/cli.rb

@@ -25,6 +25,7 @@ module Frankly
 
     def setup
       @app_path = sanitized_app_path
+      @db_name = @app_path.tr("-", "_")
     end
 
     def create_app_scaffold
@@ -35,6 +36,7 @@ module Frankly
       empty_directory "#{@app_path}/app/helpers"
       empty_directory "#{@app_path}/app/models"
       empty_directory "#{@app_path}/db/migrate"
+      empty_directory "#{@app_path}/spec/requests"
       create_file "#{@app_path}/app/controllers/.gitkeep"
       create_file "#{@app_path}/app/helpers/.gitkeep"
       create_file "#{@app_path}/app/models/.gitkeep"
@@ -50,9 +52,12 @@ module Frankly
       copy_file "config/database.rb", "#{@app_path}/config/database.rb"
       copy_file "config/environment.rb", "#{@app_path}/config/environment.rb"
       copy_file "db/seeds.rb", "#{@app_path}/db/seeds.rb"
-      copy_file "README.md", "#{@app_path}/README.md"
+      template "README.md.tt", "#{@app_path}/README.md"
       template "Gemfile.tt", "#{@app_path}/Gemfile"
       template "gitignore.tt", "#{@app_path}/.gitignore"
+      copy_file ".rspec", "#{@app_path}/.rspec"
+      copy_file "spec/spec_helper.rb", "#{@app_path}/spec/spec_helper.rb"
+      copy_file "spec/requests/app_spec.rb", "#{@app_path}/spec/requests/app_spec.rb"
       copy_file "public/css/application.css", "#{@app_path}/public/css/application.css"
       copy_file "public/js/application.js", "#{@app_path}/public/js/application.js"
       copy_file "public/favicon.ico", "#{@app_path}/public/favicon.ico"
@@ -70,13 +75,25 @@ module Frankly
       inside(@app_path) { run("bundle install") }
     end
 
+    def print_next_steps
+      say "\nNext steps:"
+      say "  cd #{@app_path}"
+      say "  bundle install#{options[:bundle] ? ' (already run because you passed --bundle)' : ''}"
+      say "  bundle exec rackup"
+      say "  Set DATABASE_URL in your environment (or use the defaults in config/database.rb)."
+      say "  Database setup is required for persistence (create DB and run migrations)."
+    end
+
     private
 
     def sanitized_app_path
-      cleaned = name.to_s.strip.downcase.gsub(/[^a-z0-9_-]/, "")
-      raise Thor::Error, "APP_NAME must include at least one letter or number" if cleaned.empty?
+      raw_name = name.to_s.strip
+      raise Thor::Error, "APP_NAME cannot be blank" if raw_name.empty?
+      unless raw_name.match?(/\A[a-zA-Z0-9][a-zA-Z0-9_-]*\z/)
+        raise Thor::Error, "APP_NAME may only include letters, numbers, hyphens, and underscores"
+      end
 
-      cleaned
+      raw_name.downcase
     end
   end
 end

data/lib/frankly/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Frankly
-  VERSION = "0.2.2"
+  VERSION = "0.2.4"
 end

data/lib/frankly.rb

@@ -1,4 +1,5 @@
 require "frankly/version"
+require "frankly/banner"
 require "frankly/cli"
 
 module Frankly

data/templates/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format documentation

data/templates/README.md.tt

@@ -0,0 +1,39 @@
+# <%= @app_path %>
+
+Generated by `frankly`.
+
+## Quickstart
+
+```sh
+bundle install
+bundle exec rackup
+```
+
+Open http://localhost:9292.
+
+## Database
+
+This app uses PostgreSQL via ActiveRecord.
+
+Environment variables:
+
+- `RACK_ENV` (default: `development`)
+- `DATABASE_URL` (default: `postgres://localhost/<%= @db_name %>_<rack_env>`)
+
+Example:
+
+```sh
+DATABASE_URL=postgres://localhost/<%= @db_name %>_development bundle exec rackup
+```
+
+Create the database and run migrations before relying on persistence:
+
+```sh
+bundle exec rake db:create db:migrate
+```
+
+## Tests
+
+```sh
+bundle exec rspec
+```

data/templates/config/database.rb

@@ -7,7 +7,7 @@ rack_env = ENV.fetch("RACK_ENV", "development")
 ActiveRecord::Base.logger = Logger.new($stdout) if rack_env == "development"
 
 build_db_config = lambda do |env_name|
-  database_url = ENV.fetch("DATABASE_URL", "postgres://localhost/#{APP_NAME}_#{env_name}")
+  database_url = ENV.fetch("DATABASE_URL", "postgres://localhost/#{DB_NAME}_#{env_name}")
   uri = URI.parse(database_url)
   database_name = uri.path.sub(%r{^/}, "")
   adapter = uri.scheme == "postgres" ? "postgresql" : uri.scheme

data/templates/config/environment.rb

@@ -11,6 +11,7 @@ require "sinatra/reloader"
 
 APP_ROOT = Pathname.new(File.expand_path("..", __dir__))
 APP_NAME = APP_ROOT.basename.to_s
+DB_NAME = APP_NAME.tr("-", "_")
 
 Dir[APP_ROOT.join("app", "helpers", "*.rb")].sort.each { |file| require file }
 Dir[APP_ROOT.join("app", "controllers", "*.rb")].sort.each { |file| require file }

data/templates/spec/requests/app_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "GET /" do
+  def app
+    App
+  end
+
+  it "returns 200 with the default home page content" do
+    get "/"
+
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to include("Frankly, it works.")
+  end
+end

data/templates/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+ENV["RACK_ENV"] = "test"
+
+require "rack/test"
+require "rspec"
+
+require_relative "../app"
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frankly
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Ken Rettberg
@@ -89,9 +89,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -102,13 +102,14 @@ files:
 - bin/setup
 - frankly.gemspec
 - lib/frankly.rb
+- lib/frankly/banner.rb
 - lib/frankly/cli.rb
 - lib/frankly/version.rb
+- templates/.rspec
 - templates/Gemfile.tt
-- templates/README.md
+- templates/README.md.tt
 - templates/Rakefile
 - templates/app.rb
-- templates/app/.DS_Store
 - templates/app/controllers/.gitkeep
 - templates/app/helpers/.gitkeep
 - templates/app/helpers/README.md
@@ -123,29 +124,29 @@ files:
 - templates/db/migrate/.gitkeep
 - templates/db/seeds.rb
 - templates/gitignore.tt
-- templates/public/.DS_Store
 - templates/public/css/application.css
 - templates/public/css/normalize.css
 - templates/public/favicon.ico
 - templates/public/js/.gitkeep
 - templates/public/js/application.js
+- templates/spec/requests/app_spec.rb
+- templates/spec/spec_helper.rb
 homepage: https://github.com/kenrett/frankly
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/kenrett/frankly
   source_code_uri: https://github.com/kenrett/frankly
 post_install_message: |2
-                .
-    .---------.'---.
-    '.       :    .'
-      '.  .:::  .' The Chairman
-        '.'::'.'    of the Board
-          '||'       has arrived.
-           ||
-           ||
-           ||
-       ---====---
+            .
+  .---------.'---.
+  '.       :    .'
+    '.  .:::  .' The Chairman
+      '.'::'.'    of the Board
+        '||'       has arrived.
+         ||
+         ||
+         ||
+     ---====---
 rdoc_options: []
 require_paths:
 - lib

data/.travis.yml

@@ -1,6 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.13.6

data/templates/README.md

@@ -1,48 +0,0 @@
-# Sinatra App
-
-Generated by `frankly`.
-
-## Requirements
-
-- Ruby 3.1+
-- PostgreSQL
-- Bundler
-
-## Quickstart
-
-```sh
-bundle install
-bundle exec rackup
-```
-
-Open http://localhost:9292.
-
-## Development reload
-
-```sh
-bundle exec rerun -- rackup
-```
-
-## Database
-
-The template uses PostgreSQL via ActiveRecord.
-
-Environment variables:
-
-- `RACK_ENV` (default: `development`)
-- `DATABASE_URL` (default: `postgres://localhost/<app_name>_<rack_env>`)
-
-Examples:
-
-```sh
-RACK_ENV=test bundle exec rake spec
-DATABASE_URL=postgres://localhost/my_app_development bundle exec rackup
-```
-
-## Common tasks
-
-```sh
-bundle exec rake spec
-bundle exec rake db:migrate
-bundle exec rake db:rollback
-```