railz_lite 0.2.3 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 582dcdab7ea03cf05ecf37d4ead94d5a2f3cc95ad1b89db6b9e93b98d7732e67
-  data.tar.gz: 507d329e1fc346cf7ede9892afb1d81a85a1bb1bc14d5c8f8eb6632a57936ae0
+  metadata.gz: aff7d4d6f62b5eee1669eef62895d5170f55a5d3241db179191a690bb9dc26f1
+  data.tar.gz: 2ab955ed52a300dcf3c614e1a0c4bcbf9f0e8ef81613e2bae9aa7324f08980db
 SHA512:
-  metadata.gz: 4d480c89f27783d171aea9fe67862080b108a8e9b2c8320e99f687119a6b5b72b189a6dede703349152c843ad5bd6a0c03fa1bc4dac3377b454b5bb3b3c2e40c
-  data.tar.gz: b6927c1850fe7bf1e4db6b29fbd13a9105eed8c4b03d0383a15f0bc09ef6fa1691b0a8483413a09c4147aaf08dd37b6af5262d37d88a15adba4556091806d415
+  metadata.gz: 0b6b915059bf4ed2ce158b1b6eef235fb742cac8fa3a416bdd88df3d4183510c632021181cec277551e86b3142253bf09732d6aed1954cf1c92b08c820c02b2b
+  data.tar.gz: 7118f1462ba3e8d772d4e64bfea0304f8cae53cebd073d9b38c97e318a3129f42bf5560369c96f7edc7b916b9a1e77e22d7d713c18ed31526a189f080f00c25b

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

data/README.md

@@ -1,8 +1,30 @@
 # RailzLite
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/railz_lite`. To experiment with that code, run `bin/console` for an interactive prompt.
+A lite-weight Ruby gem inspired by Ruby on Rails.  
 
-TODO: Delete this and the text above, and describe your gem
+To get started with a new project, execute the command
+
+```
+$ railz_lite new MyWebApp
+```
+
+This will generate controllers/, views/, models/, and other necessary directories.
+
+After changing into the root project directory, run the server command to get the Rack server running
+
+```
+$ cd MyWebApp && railz_lite server
+```
+
+To create a new sqlite3 database file, write your desired SQL code in app.sql then execute
+
+```
+$ railz_lite reset_db
+```
+
+An example web app can be found at the following repo:
+
+https://github.com/bryanqb07/trash_films
 
 ## Installation
 
@@ -22,7 +44,86 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Controllers
+
+All controllers should inherit from the RailzLite::ControllerBase class. An example is as follows:
+
+```ruby
+ class FilmsController < RailzLite::ControllerBase
+   def index
+     @films = Film.all
+   end
+
+   def show
+     @film = Film.find(params['id'])
+   end
+ end
+```
+
+### Models
+
+Models inherit from RailzLite::SQLObject. Please note that any class declaration must be ended with a finalize! statement
+
+```ruby
+class Film < RailzLite::SQLObject
+  has_many :reviews, foreign_key: :film_id
+  def average_rating
+    ratings = reviews.map(&:rating)
+    return 0 if ratings.empty?
+    
+    ratings.reduce(:+) / reviews.length
+  end
+  finalize!
+end
+```
+
+### Views 
+
+Views use the rails convention for path-resolution. Also, they are required to end in a .erb extension, even if no embedded ruby is used.  
+
+ex. FilmsController#index corresponds to /views/films/index.html.erb
+
+### Server + Routes
+
+The server file can be found in config/server. 
+
+Routes are configured in the following structure 
+
+```
+http_method, regex to match route, controller, action
+```
+
+Below is an example route config:
+```ruby
+router.draw do
+  # add routes here
+  get Regexp.new('^/films$'), FilmsController, :index
+  get Regexp.new("^/films/(?<id>\\d+)$"), FilmsController, :show
+
+  get Regexp.new("^/films/(?<film_id>\\d+)/reviews/new$"), ReviewsController, :new
+  post Regexp.new("^/films/(?<film_id>\\d+)/reviews$"), ReviewsController, :create
+end
+```
+
+### Assets
+
+Assets are served via the static middleware included within the framework. The default load paths for assets are "/public" and "/assets".
+Any file within these two folders can be accessed in the app by specifying the root folder + the file name.
+
+ex.) MyProject/public/balloons.jpg
+
+```html
+<h1>Congratulations!!! <img src="public/balloons.jpg" /></h1>
+```
+
+ex.) MyProject/assets/home.css
+
+```html
+  <head>
+    <title>My Project</title>
+    <link rel="stylesheet" href="assets/application.css">
+  </head>
+```
 
 ## Development
 

data/lib/railz_lite/controllers/controller_base.rb

@@ -1,6 +1,7 @@
 require 'active_support'
 require 'active_support/core_ext'
 require 'erb'
+require 'loofah'
 require_relative './session'
 require_relative './flash'
 
@@ -62,7 +63,8 @@ module RailzLite
       layout.def_method(LayoutRenderer, 'render') # dummy method used so that blocks can be passed to ERB result
 
       result = LayoutRenderer.new.render do
-        inner.result(binding)
+        inner_html = inner.result(binding)
+        Loofah.fragment(inner_html).scrub!(:prune).to_s # prevent non-safe html from being executed
       end
 
       render_content(result, 'text/html')

data/lib/railz_lite/controllers/static.rb

@@ -1,11 +1,11 @@
 require 'rack'
 
 class Static
-  attr_reader :app, :file_server, :root
+  attr_reader :app, :file_server, :root_paths
 
   def initialize(app)
     @app = app
-    @root = 'public'
+    @root_paths = ['public', 'assets']
     @file_server = FileServer.new
   end
 
@@ -13,17 +13,21 @@ class Static
     req = Rack::Request.new(env)
     path = req.path
 
-    if can_match?(path)
-      file_server.call(env)
-    else
+    asset_dir = get_asset_dir(path)
+
+    if asset_dir.nil?
       app.call(env)
+    else
+      file_server.call(env, asset_dir)
     end
   end
 
   private
 
-  def can_match?(path)
-    path.index("/#{root}")
+  # return the root directory of asset request ex => 'films/assets/app.css' would return 'assets'
+  def get_asset_dir(path)
+    root_paths.each { |root| return root if path.include?(root) }
+    nil
   end
 end
 
@@ -32,12 +36,14 @@ class FileServer
   MIME_TYPES = {
     '.txt' => 'text/plain',
     '.jpg' => 'image/jpeg',
-    '.zip' => 'application/zip'
+    '.zip' => 'application/zip',
+    '.css' => 'text/css',
+    '.js' => 'text/javascript'
   }
 
-  def call(env)
+  def call(env, asset_dir)
     res = Rack::Response.new
-    file_name = requested_file_name(env)
+    file_name = requested_file_name(env, asset_dir)
 
     if File.exist?(file_name)
       serve_file(file_name, res)
@@ -58,10 +64,11 @@ class FileServer
     res.write(file)
   end
 
-  def requested_file_name(env)
+  def requested_file_name(env, asset_dir)
     req = Rack::Request.new(env)
-    path = req.path
     dir = Dir.pwd
-    File.join(dir, path)
+    path = req.path
+    filename = File.basename(path)
+    File.join(dir, asset_dir, filename)
   end
 end

data/lib/railz_lite/generators/project.rb

@@ -29,7 +29,10 @@ module RailzLite
       def setup_views
         template('welcome_view.index.html.erb', "#{project_name}/views/welcome/index.html.erb")
         template('application.html.erb', "#{project_name}/views/application/application.html.erb")
-        create_file("#{project_name}/views/application/application.css")
+      end
+
+      def add_assets
+        create_file("#{project_name}/assets/application.css")
       end
 
       def add_public

data/lib/railz_lite/generators/templates/application.html.erb

@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>App Title</title>
-    <link rel="stylesheet" href="application.css">
+    <link rel="stylesheet" href="assets/application.css">
   </head>
   <body>
     <%= yield %>

data/lib/railz_lite/generators/templates/server.rb

@@ -24,7 +24,7 @@ end
 
 app = Rack::Builder.new do
   use ShowExceptions # generates helpful error messages
-  use Static # serves static assets from /public
+  use Static # serves static assets from /public and /assets
   run app
 end.to_app
 

data/lib/railz_lite/generators/templates/welcome_view.index.html.erb

@@ -6,7 +6,7 @@
     ">
   <h1>Welcome To Railz Lite!</h1>
 
-  <img src="../public/winter_fox_large.jpg" />
+  <img src="public/winter_fox_large.jpg" />
 
   <h3>For guidelines on how to build an app with this framework see <a href="https://github.com/bryanqb07/railz_lite">here</a>.</h3>
 </div>

data/lib/railz_lite/models/db_connection.rb

@@ -1,4 +1,5 @@
-require 'sqlite3'
+require_relative 'wrappers/pg_wrapper'
+require_relative 'wrappers/sqlite3_wrapper'
 
 class DBConnection
   PRINT_QUERIES = ENV['PRINT_QUERIES'] == 'true'
@@ -10,22 +11,27 @@ class DBConnection
     DBConnection.open(DB_FILE)
   end
 
-  def self.open(db_file_name)
-    @db = SQLite3::Database.new(db_file_name)
-    @db.results_as_hash = true
-    @db.type_translation = true
+  def self.open(db_name) # for sqlite3 we need file.db, for postgresql we need database name
+    db_uri = ENV['DATABASE_URL']
+
+    @db = db_uri.nil? ?  SQLite3Wrapper.new(db_name) : PGWrapper.new(db_uri) 
 
     @db
   end
 
   def self.reset
-    commands = [
-      "rm '#{DB_FILE}'",
-      "cat '#{SQL_FILE}' | sqlite3 '#{DB_FILE}'"
-    ]
+    db_uri = ENV['DATABASE_URL']
 
-    commands.each { |command| `#{command}` }
-    DBConnection.open(DB_FILE)
+    if db_uri.nil? # sqlite
+      commands = ["rm '#{DB_FILE}'", "cat '#{SQL_FILE}' | sqlite3 '#{DB_FILE}'"]
+
+      commands.each { |command| `#{command}` }
+      DBConnection.open(DB_FILE)
+    else # postgres
+      DBConnection.open(db_uri)
+      sql = File.read(SQL_FILE)
+      instance.execute(sql)
+    end
   end
 
   def self.instance
@@ -34,20 +40,25 @@ class DBConnection
     @db
   end
 
+  # results hash of results [{id: 1, name: 'Bob'}...]
   def self.execute(*args)
     print_query(*args)
     instance.execute(*args)
   end
 
+  # returns result with header fields [['id', 'name'...], { id: 1, name: 'Bob' ... }
   def self.execute2(*args)
     print_query(*args)
     instance.execute2(*args)
   end
 
-  def self.last_insert_row_id
-    instance.last_insert_row_id
+  # used to insert data into tables
+  def self.insert(*args)
+    print_query(*args)
+    instance.insert(*args)
   end
 
+
   private
 
   def self.print_query(query, *interpolation_args)

data/lib/railz_lite/models/sql_object.rb

@@ -82,13 +82,13 @@ module RailzLite
     end
 
     def insert
-      DBConnection.execute(<<-SQL, *attribute_values)
+      last_row_id = DBConnection.insert(<<-SQL, *attribute_values)
       INSERT INTO
         #{self.class.table_name}(#{self.class.columns.join(',')})
       VALUES
         (#{(["?"] * attribute_values.length).join(',')})
     SQL
-      self.id = DBConnection.last_insert_row_id
+      self.id = last_row_id
     end
 
     def update

data/lib/railz_lite/models/wrappers/pg_wrapper.rb

@@ -0,0 +1,46 @@
+require 'pg'
+
+class PGWrapper
+  def initialize(db_uri)
+    @db = PG::Connection.new(db_uri)
+    @db.type_map_for_results = PG::BasicTypeMapForResults.new(@db) # converts pgsql strings to ruby type
+    @db
+  end
+
+  def execute(sql, *args)
+    converted_sql = convert_escaped_question_marks(sql)
+    @db.exec_params(converted_sql, args).to_a
+  end
+
+  def execute2(sql, *args)
+    converted_sql = convert_escaped_question_marks(sql)
+    result = @db.exec_params(converted_sql, args) 
+    [result.fields, result.to_a]
+  end
+
+  def insert(sql, *args)
+    sql.insert(sql.index(';'), ' RETURNING ID')
+    converted_sql = convert_escaped_question_marks(sql)
+    result = @db.exec_params(converted_sql, *args)
+    result.to_a.first['id']
+  end
+
+
+  private
+
+  # for pgsql, SELECT * FROM films WHERE x = ?;  must be converted to SELECT * FROM films WHERE x = $1;
+  def convert_escaped_question_marks(sql)
+    converted_sql = ""
+    index = 1
+    sql.each_char do |char|
+      if char == '?'
+        converted_sql += "$#{index}"
+        index += 1
+      else
+        converted_sql += char
+      end
+    end
+    converted_sql
+  end
+
+end

data/lib/railz_lite/models/wrappers/sqlite3_wrapper.rb

@@ -0,0 +1,30 @@
+require 'sqlite3'
+
+class SQLite3Wrapper
+  def initialize(db_file_name)
+    @db = SQLite3::Database.new(db_file_name)
+    @db.results_as_hash = true
+    @db.type_translation = true
+
+    @db
+  end
+
+  def execute(*args)
+    @db.execute(*args)
+  end
+
+  def execute2(*args)
+    @db.execute2(*args)
+  end
+
+  def insert(*args)
+    execute(*args)
+    last_insert_row_id
+  end
+
+  private
+
+  def self.last_insert_row_id
+    @db.last_insert_row_id
+  end
+end

data/lib/railz_lite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailzLite
-  VERSION = "0.2.3"
+  VERSION = "0.2.8"
 end

data/railz_lite.gemspec

@@ -29,11 +29,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "rack"
-  spec.add_dependency "activesupport"
-  spec.add_dependency "puma"
-  spec.add_dependency "sqlite3"
-  spec.add_dependency "thor"
+  spec.add_dependency "rack", '~> 2.2.3'
+  spec.add_dependency "activesupport", '~> 6.1.4'
+  spec.add_dependency "puma", '~> 5.3.2'
+  spec.add_dependency "sqlite3", '~> 1.4.2'
+  spec.add_dependency "pg", '~> 1.2.3'
+  spec.add_dependency "thor", '~> 1.1.0'
+  spec.add_dependency "loofah", '~> 2.10.0'
 
 
   spec.add_development_dependency "byebug"

metadata

@@ -1,85 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: railz_lite
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.8
 platform: ruby
 authors:
 - bryan lynch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-03 00:00:00.000000000 Z
+date: 2021-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.3
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.4
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.3.2
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: loofah
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +206,8 @@ files:
 - lib/railz_lite/models/searchable.rb
 - lib/railz_lite/models/sql_object.rb
 - lib/railz_lite/models/validatable.rb
+- lib/railz_lite/models/wrappers/pg_wrapper.rb
+- lib/railz_lite/models/wrappers/sqlite3_wrapper.rb
 - lib/railz_lite/version.rb
 - railz_lite.gemspec
 homepage: https://github.com/bryanqb07/my_rails