sinatra-rax 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fe9300a8a392c80645f184a87f6e8b33bf03a4d157fc6184a2bdee9afb3aa634
+  data.tar.gz: da243894f05a87facdc62231677c9aab96dbeba5e114296221ef9605fd2ef66e
+SHA512:
+  metadata.gz: b367a0a7a5bf7b03a65316864eec97086d32584a202dbde7efdb888ff8db175d6590cbb3ced21bacb20ccf900d9c53913dfca1c8fbd2ec397f18dd814e70aca8
+  data.tar.gz: c640bef8191fe0b93307812b7b2e72358d4cb7ed0be9af7b6a130f6a11e14484af5f4353840fea0acf2e7283b7785de32d2cb801aaf1ba20a215b962f45d488b

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Steve Shreeve
+
+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,159 @@
+# sinatra-rax
+
+`sinatra-rax` is a minimal and modern Ruby/IRB console for Sinatra apps.
+
+## Goals
+
+1. Call `app.get '/'` to trigger a request
+2. Easily call Sinatra helpers, such as `app.current_weather`
+3. Set ivars like `app.set(name: 'bob', age: 25)`
+4. Use templates like `app.erb :test` (using `name` from above)
+5. Set ivars like `@name='mike'`, then `app.erb :test, scope: self`
+6. Normal access to database calls, like `Sponsor[2]` to show a record
+7. Call `routes` to show list sorted by route
+8. Call `props` to show application settings
+
+
+## Examples
+
+```ruby
+project/api> rax
+
+development(main):001:0> app # an application instance (Sinatra::Application.new!)
+=> #<Sinatra::Application:0x0000000108b1ae50
+ @app=Sinatra::Application,
+ @default_layout=:layout,
+ @pinned_response=nil,
+ @preferred_extension=nil,
+ @request=#<Sinatra::Request:0x0000000108b1a838 @env={}, @params=nil>,
+ @response=
+  #<Sinatra::Response:0x0000000108addbb8
+   @block=nil,
+   @body=[],
+   @buffered=true,
+   @headers={},
+   @length=0,
+   @status=200,
+   ...
+ @template_cache=#<Tilt::Cache:0x0000000108b1aae0 @cache={}>>
+
+development(main):002:0> app.app # the application class
+=> Sinatra::Application
+
+development(main):003:0> app.get '/ping' # mock a request
+
+{
+  "pong": true
+}
+
+=> #<Rack::MockResponse:0x00000001088f94c8
+ @block=nil,
+ @body=["{\n  \"pong\": true\n}"],
+ @buffered=true,
+ @cookies={},
+ @errors="",
+ @headers={"Content-Type"=>"application/json", "Content-Length"=>"18"},
+ @length=18,
+ @original_headers={"Content-Type"=>"application/json", "Content-Length"=>"18"},
+ @status=200,
+ ...
+
+development(main):004:0> app.current_weather # call a helper method
+=> "sunny and warm"
+
+development(main):005:0> app.set(name: 'bob', age: 25); app.instance_variables # set instance vars
+=>
+[:@default_layout,
+ :@preferred_extension,
+ :@app,
+ :@template_cache,
+ :@pinned_response,
+ :@request,
+ :@response,
+ :@_rack_test_sessions,
+ :@_rack_test_current_session,
+ :@name,
+ :@age]
+
+development(main):006:0> app.erb "Hello, <%= @name %> (age <%= @age %>)" # render a template
+ => "Hello, bob (age 25)"
+
+development(main):007:0> app.set(name: 'joe', age: 50).erb("Hello, <%= @name %> (age <%= @age %>)") # one step
+=> "Hello, joe (age 50)"
+
+development(main):008:0> @name = "waldo"; @age = 19; app.erb "Hello, <%= @name %> (age <%= @age %>)", scope: self # scoping
+=> "Hello, waldo (age 19)"
+
+development(main):009:0> Sponsor[2] # direct access to db models
+=> #<Sponsor:0x00000001092bad40
+ id: 2,
+ slug: "tesla",
+ name: "Tesla",
+ link: "https://tesla.com",
+ email: "info@tesla.com",
+ logo: "tesla-logo.png",
+ title: "Tesla",
+ heading: "Accelerating sustainable transport and electric technology",
+ subheading: nil,
+ created_at: 2023-01-12 05:06:35.751006 UTC,
+ updated_at: 2023-01-12 05:06:35.751006 UTC>
+
+development(main):010:0> routes # show sorted routes and methods
+get     "/"
+post    "/access"
+post    "/signin"
+post    "/signin/assignpin"
+post    "/signin/changepin"
+post    "/signin/checkpin"
+delete  "/users"
+get     "/users"
+get     "/users/:id"
+=> nil
+
+development(main):011:0> props # show app settings
+absolute_redirects    true
+add_charset           ["application/javascript", "application/xml", "application/xhtml+xml", /^text\//]
+app_file              "/Users/shreeve/project/api/api.rb"
+bind                  "localhost"
+default_content_type  "text/html"
+default_encoding      "utf-8"
+dump_errors           true
+empty_path_info       nil
+environment           :development
+handler_name          nil
+lock                  false
+logging               false
+method_override       true
+mustermann_opts       {}
+port                  4567
+prefixed_redirects    false
+protection            {:reaction=>:deny, :except=>[:json_csrf, :frame_options, :xss_header, :http_origin]}
+public                nil
+public_dir            "/Users/shreeve/project/api/public"
+public_folder         "/Users/shreeve/project/api/public"
+quiet                 false
+raise_errors          false
+reload_templates      true
+reloader              true
+root                  "/Users/shreeve/project/api"
+run                   false
+running_server        nil
+server                ["thin", "falcon", "puma", "HTTP", "webrick"]
+session_secret        "--secret--"
+session_store         Rack::Protection::EncryptedCookie
+sessions              false
+show_exceptions       false
+static                false
+static_cache_control  false
+strict_paths          false
+threaded              true
+traps                 true
+use_code              false
+views                 "/Users/shreeve/project/api/views"
+x_cascade             true
+=> nil
+```
+
+## License
+
+This software is licensed under terms of the MIT License.

data/bin/rax

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+
+# ==============================================================================
+# rax - A minimal and modern Ruby/IRB console for Sinatra apps
+#
+# Author: Steve Shreeve (steve.shreeve@gmail.com)
+#   Date: Jan 15, 2023
+# ==============================================================================
+# NOTE: Here are the goals...
+#
+# 1. Call `app.get '/'` to trigger a request
+# 2. Easily call Sinatra helpers, such as `app.current_weather`
+# 3. Set ivars like `app.set(name: 'bob', age: 25)`
+# 4. Use templates like `app.erb :test` (using `name` from above)
+# 5. Set ivars like `@name='mike'`, then `app.erb :test, scope: self`
+# 6. Normal access to database calls, like `Sponsor[2]` to show a record
+# 7. Call `routes` to show list sorted by route
+# 8. Call `props` to show application settings
+# ==============================================================================
+
+STDOUT.sync = true
+
+require 'bundler/setup'
+require 'irb'
+require 'rack/test'
+
+IRB::ExtendCommandBundle::HushAliasWarning = true
+
+class Rax
+  attr_reader :env, :app
+
+  def initialize(file=nil)
+    @env = ENV['APP_ENV'] ||= ENV['RACK_ENV'] || 'development'
+    @app = Rack::Builder.parse_file(file || ENV['RACK_CONFIG'] || 'config.ru')[0]
+  end
+
+  def self.instance
+    @instance ||= new
+  end
+
+  def self.app
+    instance.app
+  end
+end
+
+def env
+  @env ||= Rax.instance.env
+end
+
+def app
+  @app ||= begin
+    app          = Rax.app.new!
+    app.app      = Rax.app
+    app.extend     Rack::Test::Methods
+    app.request  = Sinatra::Request.new({})
+    app.response = Sinatra::Response.new
+    app
+  end
+end
+
+def app!
+  @app = nil
+  app
+end
+
+def app.set(**vars)
+  vars.each {|k,v| instance_variable_set "@#{k}", v }
+  self
+end
+
+def display(list)
+  wide = list.map {|e| e[0].length }.max
+  list.each {|a, b| puts "%-*s  %s" % [wide, a, b.inspect] }
+  nil
+end
+
+def routes
+  list = Rax.app.routes.except 'HEAD'
+  list = list.inject([]) do |list, (meth, hits)|
+    list += hits.map {|vals| [meth.downcase, vals[0].to_s] }
+  end
+  list = list.sort_by {|a, b| [b, a]}
+  display list
+end
+
+def props
+  skip = %w[ inline_templates methodoverride ]
+  list = app.methods(false) | Rax.app.methods(false) | Sinatra::Base.methods(false)
+  list = list.filter_map {|meth| meth[/^(.*?)=$/, 1] }.sort - skip
+  list = list.map {|meth| [meth, (Rax.app.send(meth) rescue $!.inspect)] }
+  display list
+end
+
+# launch IRB
+IRB.setup nil
+IRB.conf[:IRB_NAME] = "\e[36m#{env}\e[0m"
+IRB::Irb.new.run IRB.conf

data/sinatra-rax.gemspec

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name        = "sinatra-rax"
+  s.version     = "1.0"
+  s.author      = "Steve Shreeve"
+  s.email       = "steve.shreeve@gmail.com"
+  s.summary     = "A minimal and modern Ruby/IRB console for Sinatra apps"
+  s.description = "Provides a simple console to interact with Sinatra apps"
+  s.homepage    = "https://github.com/shreeve/sinatra-rax"
+  s.license     = "MIT"
+  s.files       = `git ls-files`.split("\n") - %w[.gitignore]
+  s.executables = `cd bin && git ls-files .`.split("\n")
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-rax
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Steve Shreeve
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-15 00:00:00.000000000 Z
+dependencies: []
+description: Provides a simple console to interact with Sinatra apps
+email: steve.shreeve@gmail.com
+executables:
+- rax
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- bin/rax
+- sinatra-rax.gemspec
+homepage: https://github.com/shreeve/sinatra-rax
+licenses:
+- MIT
+metadata: {}
+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.4.3
+signing_key:
+specification_version: 4
+summary: A minimal and modern Ruby/IRB console for Sinatra apps
+test_files: []