jails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f53ada8cf3d1d775d9f47993c8139a883211f4ab
+  data.tar.gz: ea8af3753aea35be1c8a300f99b81c56a9ba776e
+SHA512:
+  metadata.gz: 7024db4c3466b3f4f2f0b23257db233155b6ca586f6e256a269bd46ddfa846c5ea3a9e36feccff5e15d25ca01e0f0d7dad5d59ebb14155862d13bcc0f076d163
+  data.tar.gz: '0483d20143deba21b48bd844eae76cfb80307b1a017aaac9bb61c19592fd6236a113cde9609771f85ab3b73a170041a9b5e488070525b3ee604bdf6d39c38370'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Steve Carey
+
+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,39 @@
+# Jails
+
+This gem is for learning purposes only. It is the companion to the tutorial Build Your Own Rails. Full explanation of the code in this gem and how to use it with a web application are at:
+https://www.techandstartup.org/tutorials/build-your-own-rails
+This is a very simplified Web framework using the Model View Controller architecture, following as much of the feel of Rails as possible while keeping it very simple. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jails
+
+## Usage
+
+This Gem is for learning purposes only and it is not meant to be used for a real project. 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jails.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/jails.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jails"
+  spec.version       = Jails::VERSION
+  spec.authors       = ["Steve Carey"]
+  spec.email         = ["steve981cr@gmail.com"]
+
+  spec.summary       = %q{For-learning-purposes-only web application framework.}
+  spec.description   = %q{Ruby in Jails is a cheap, primitive, amateur attempt at a Web MVC framework strictly for learning purposes.}
+  spec.homepage      = "https://www.techandstartup.org/tutorials/build-your-own-rails"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = Dir["LICENSE.txt","Rakefile","README.md","jails.gemspec","lib/**/*"]
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "rack", "~> 2.0"
+end

data/lib/jails.rb

@@ -0,0 +1,17 @@
+require('jails/version.rb')
+require('jails/support.rb')
+require('jails/routing.rb')
+require('jails/controller.rb')
+require('jails/hacktive_record.rb')
+
+module Jails
+  class Application
+    # Instantiate a Request object, instantiate Routing object and call dispatch method, ultimately return response.
+    def call(env)
+      request = Rack::Request.new(env)
+      puts("\n\nStarted #{request.request_method} \"#{request.path}\" for #{request.ip} #{Time.now}")
+      response = Routing.new(request).dispatch
+      return response
+    end
+  end
+end

data/lib/jails/controller.rb

@@ -0,0 +1,68 @@
+class Controller
+  include Support
+
+  # Set request object as an attribute accessible with @request variable.
+  def initialize(request)
+    @request = request
+    puts("\s Parameters #{@request.params}")  
+  end
+
+  # helper method, params returns @request.params
+  def params
+    @request.params
+  end
+
+  # Return Rack response object with the erb template.
+  def render
+    resource = params[:resource]
+    action = params[:action]
+    template = "#{resource}/#{action}.html.erb"
+    file = File.join('app', 'views', template)
+    if File.exist?(file)
+      puts("\s Rendering #{template}") # Prints in log
+      render_template = ERB.new(File.read(file)).result(binding)
+      puts "\s Rendered #{template}"
+      response = Rack::Response.new([render_template], 200, {"Content-Type" => "text/html"})
+      puts "Completed 200 OK"
+      return response
+    else
+      puts("\s Missing Template #{template}.")
+      response = Rack::Response.new(["Nothing found"], 404, {"Content-Type" => "text/html"})
+      return response
+    end
+  end
+
+  # Return rendered partial template to be inserted into the parent template that called it.
+  def render_partial(template)
+    file = File.join('app', 'views', template)
+    if File.exists?(file)
+      rendered_partial = ERB.new(File.read(file)).result(binding)
+      puts "\s Rendered #{template}"
+      return rendered_partial
+    else
+      puts("\s Missing Template #{template}.")
+    end
+  end
+
+  # Return Rack response with header field Location assigned to path in argument.
+  def redirect_to(path)
+    response = Rack::Response.new([], 302, {"Location" => path})
+    return response
+  end
+
+  # Set cookie with parameter key:value, then redirect back.
+  def set_new_cookie(key, value)
+    Rack::Response.new do |response|
+      response.set_cookie(key, value)
+      response.redirect(@request.referer || @request.path)
+    end
+  end
+
+  # Delete cookie with parameter key and redirect back.
+  def delete_the_cookie(key)
+    Rack::Response.new do |response|  
+      response.delete_cookie("greet")
+      response.redirect(@request.referer || @request.path)
+    end
+  end
+end

data/lib/jails/hacktive_record.rb

@@ -0,0 +1,71 @@
+require "sqlite3"
+
+# Simplistic ORM library using the Active Record pattern
+module HacktiveRecord
+  class Base
+    DB = SQLite3::Database.new("db/development.sqlite3")
+
+    # Return table name string by transforming the model class's name to lower case plural.
+    def self.table
+      table_name = self.name.downcase + "s"
+      return table_name
+    end
+
+    # Return array of DB column names converted to symbols.
+    def self.columns
+      columns = DB.table_info(table).map { |info| info["name"].to_sym }
+      return columns
+    end
+
+    # Return number of rows by executing a count query on the database for the resource.
+    def self.count
+      rows_count = DB.execute("SELECT COUNT(*) FROM #{table}")[0][0]
+      return rows_count
+    end
+
+    # Return array of all rows in queried from the database table, converted to objects of the resource.
+    def self.all
+      rows = DB.execute("SELECT * FROM #{table}")
+      objects = rows.map do |row|
+        attributes = Hash[columns.zip(row)]
+        self.new(attributes)
+      end
+      return objects
+    end
+
+    # Return an object by querying the database for the requested row searching by id.
+    def self.find(id)
+      row = DB.execute("SELECT * FROM #{table} WHERE id = ? LIMIT 1", id).first 
+      attributes = Hash[columns.zip(row)]
+      object = self.new(attributes)
+      return object
+    end
+
+    # Save object as a new row to the database table, returning the object with the new attribute's id value.
+    def save
+      new_object = self
+      columns = new_object.class.columns
+      columns.delete(:id)
+      placeholders = (["?"] * (columns.size)).join(",") 
+      values = columns.map { |key| self.send(key) } 
+      columns = columns.join(",") 
+      DB.execute("INSERT INTO #{self.class.table} (#{columns}) VALUES (#{placeholders})", values)
+      new_object.id = DB.execute("SELECT last_insert_rowid()")[0][0]
+      return new_object
+    end
+
+    # Modify row in database.
+    def update(attributes={})
+      columns = attributes.keys
+      columns = columns.map { |column| "#{column}=?" }.join(",")
+      values = attributes.values
+      values << id
+      DB.execute("UPDATE #{self.class.table} SET #{columns} WHERE id = ?", values)
+    end
+
+    # Delete row from database.
+    def destroy
+      DB.execute("DELETE FROM #{self.class.table} WHERE id = ?", id)
+    end
+  end
+end

data/lib/jails/routing.rb

@@ -0,0 +1,43 @@
+class Routing
+
+  # Set request object as an attribute. Declare a routes attribute. Call the draw method to populate it with a hash of routes.
+  def initialize(request)
+    @request = request
+    @routes = {} 
+    draw(Application.routes)
+  end
+
+  # Build the @routes hash by evaluating the block passed in as a proc object from the Application.routes method.
+  def draw(block)   
+    instance_eval(&block)
+  end
+
+  # Add route to @routes hash with the url's path as the key and target as the value.
+  def match(path, target)
+    @routes["#{path}"] = target
+  end
+
+  # Match request path to @routes hash. If match, create controller object and call the action.
+  def dispatch
+    path = @request.path
+    id = nil
+    segments = path.split("/").reject { |segment| segment.empty? }
+    if segments[1] =~ /^\d+$/
+      id = segments[1]
+      segments[1] = ":id"
+      path = "/#{segments.join('/')}"
+    end
+    if @routes.key?(path)
+      target = @routes[path]
+      resource_name, action_name = target.split('#')
+      @request.params.merge!(resource: resource_name, action: action_name, id: id)
+      klass = Object.const_get("#{resource_name.capitalize}Controller")
+      puts("Processing by #{klass}##{action_name}")
+      klass.new(@request).send(action_name)
+    else
+      Rack::Response.new(["Nothing found"], 404, {"Content-Type" => "text/html"})
+    end
+  rescue Exception => error
+    Rack::Response.new(["Internal error"], 500, {"Content-Type" => "text/html"})
+  end
+end

data/lib/jails/support.rb

@@ -0,0 +1,8 @@
+module Support
+  # Transform string, downcase all words, capitalize each not on list, capitalize first word. 
+  def titleize(string)
+    words_not_to_capitalize = ["the","a","an","and","but","for","of","to","at","by","from"]
+    s = string.split.each{|word| word.capitalize! unless words_not_to_capitalize.include? (word.downcase) }
+    s[0].capitalize + " " + s[1..-1].join(" ")
+  end
+end

data/lib/jails/version.rb

@@ -0,0 +1,3 @@
+module Jails
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: jails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Carey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Ruby in Jails is a cheap, primitive, amateur attempt at a Web MVC framework
+  strictly for learning purposes.
+email:
+- steve981cr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- jails.gemspec
+- lib/jails.rb
+- lib/jails/controller.rb
+- lib/jails/hacktive_record.rb
+- lib/jails/routing.rb
+- lib/jails/support.rb
+- lib/jails/version.rb
+homepage: https://www.techandstartup.org/tutorials/build-your-own-rails
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: For-learning-purposes-only web application framework.
+test_files: []