frankly 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec34b9f3424166a083d2a66f867231d933b2aadaa59f0c5cd05d5ef9f0cc99f0
-  data.tar.gz: 70e164681f51d310b3c9316f59af12e328342eb41733592bea9f1e4c4da53b1b
+  metadata.gz: 55072e2189a10b13cd3beca25cc58d0aed428099f250d2533f3690e9ac44e7d0
+  data.tar.gz: 346209309426c1496898246056fcebbd23a07820947ec060982a1049b5017805
 SHA512:
-  metadata.gz: 06cd91c94c621288f7f2ee5df4840c8e20b9bcfb25964fecd9c450ac7b609e4a485c9c948586a5ba43dc459d9e4997a76b19ad735a7b47b9580cf5ef51e4b867
-  data.tar.gz: 1353cf106c8ab649ce7a4dba097a92081aeb5bdedd7939195fe2e00782efc5858b118b736e32dcfd07834035943c17d459ee6677bd1d8077c5df78c8493b086d
+  metadata.gz: e022caa9ec66a23734a3f6577dbf38220143ff2c74822ad2541c9f775458b06b84cefbe7ccb6b893d549310af4307f037916506e10da73762139a00fe92bcc8a
+  data.tar.gz: 2b89f270e32860808ead382424c2b2b670531bf1a3e327526b4a2447348729ef6d4a72a2847906456bc0cfebbe72e9e8575407528a4a054e717e201a598f0126

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
 
@@ -16,30 +16,13 @@ It creates a PostgreSQL + ActiveRecord app scaffold with a modern Sinatra setup.
 gem install frankly
 ```
 
-Install and runtime banner:
-
-```text
-              .
-  .---------.'---.
-  '.       :    .'
-    '.  .:::  .' The Chairman
-      '.'::'.'    of the Board
-        '||'       has arrived.
-         ||
-         ||
-         ||
-     ---====---
-```
-
 ## Usage
 
-Generate a new app:
-
 ```sh
 frankly my_app
 ```
 
-### Options
+Common options:
 
 ```sh
 frankly my_app --bundle
@@ -49,15 +32,48 @@ 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
 bundle install
 bundle exec rackup
+bundle exec bin/console
 ```
 
-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)
 
@@ -66,19 +82,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/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,12 +52,17 @@ 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"
+      copy_file "bin/console", "#{@app_path}/bin/console"
+      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"
+      chmod "#{@app_path}/bin/console", 0o755
     end
 
     def initialize_git_repo
@@ -70,13 +77,26 @@ 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 "  bundle exec bin/console"
+      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.3"
+  VERSION = "0.2.5"
 end

data/templates/.rspec

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

data/templates/README.md.tt

@@ -0,0 +1,40 @@
+# <%= @app_path %>
+
+Generated by `frankly`.
+
+## Quickstart
+
+```sh
+bundle install
+bundle exec rackup
+bundle exec bin/console
+```
+
+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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup"
+require_relative "../config/environment"
+
+begin
+  require "pry"
+  Pry.start
+rescue LoadError
+  require "irb"
+  IRB.start(__FILE__)
+end

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.3
+  version: 0.2.5
 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
@@ -105,11 +105,11 @@ files:
 - 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
@@ -118,18 +118,20 @@ files:
 - templates/app/views/.gitkeep
 - templates/app/views/index.erb
 - templates/app/views/layout.erb
+- templates/bin/console
 - templates/config.ru
 - templates/config/database.rb
 - templates/config/environment.rb
 - 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

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
-```