RubyGems - railz_lite - Versions diffs - 0.2.7 → 0.2.8 - Mend

railz_lite 0.2.7 → 0.2.8

Files changed (9) hide show

checksums.yaml +4 -4
data/README.md +104 -3
data/lib/railz_lite/models/db_connection.rb +24 -13
data/lib/railz_lite/models/sql_object.rb +2 -2
data/lib/railz_lite/models/wrappers/pg_wrapper.rb +46 -0
data/lib/railz_lite/models/wrappers/sqlite3_wrapper.rb +30 -0
data/lib/railz_lite/version.rb +1 -1
data/railz_lite.gemspec +1 -0
metadata +18 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e77147f68729fb2f1b68f730aa31e1e50ca822df8990e6fb35ba9eb2e02cbf5d
-  data.tar.gz: e96ec7817513298e3899cde8d3e9d3f43cbc97589302443db38c4ec8a993258b
+  metadata.gz: aff7d4d6f62b5eee1669eef62895d5170f55a5d3241db179191a690bb9dc26f1
+  data.tar.gz: 2ab955ed52a300dcf3c614e1a0c4bcbf9f0e8ef81613e2bae9aa7324f08980db
 SHA512:
-  metadata.gz: 5968f44535f416c2524445365be98cacfe92894e1ed1079268cb8261ea0c44bd8101ad9f7fb62d84677fb0f2e5f57937f955144046bb1c399659b61c0065acb2
-  data.tar.gz: 958a09155c32bd8707908f4a820a2cc5e8f4116e0d90fa91c44ca24855827df3e4819ab31a410beffeb866615013418012890bab1237d105e0e9111bba4664ac
+  metadata.gz: 0b6b915059bf4ed2ce158b1b6eef235fb742cac8fa3a416bdd88df3d4183510c632021181cec277551e86b3142253bf09732d6aed1954cf1c92b08c820c02b2b
+  data.tar.gz: 7118f1462ba3e8d772d4e64bfea0304f8cae53cebd073d9b38c97e318a3129f42bf5560369c96f7edc7b916b9a1e77e22d7d713c18ed31526a189f080f00c25b

data/README.md CHANGED Viewed

@@ -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/models/db_connection.rb CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 CHANGED Viewed

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

data/railz_lite.gemspec CHANGED Viewed

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   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'

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: railz_lite
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  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
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         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
@@ -192,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