ruby-freedom 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f0b7c517dc392b864435c8829ec2b7b4e7095accd2aad447e60b4d06e20c0d2
+  data.tar.gz: 0dabf4a60ecbe9f6480e3e5503a44d1e2aaf9c7afea89029730634fe63146e1c
+SHA512:
+  metadata.gz: d49d2e3afc33373c1c646a75c2f46b6b3c0fe649119c4206179c8ea17f00ce9bfffa5542d9c0346b2ad6525831b5f48e1dcb8807505130253c33507e16119949
+  data.tar.gz: 8ac7fa6cf6ce590296b43bd3a3512e06692232e6edb4a37444d463a6560243cac7eff09e83887f3e9d0ce020c96721bb8f838437013f718267140690df2a4122

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ootoro838861@outlook.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in freedom.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 unagiootoro
+
+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,42 @@
+# Freedom
+
+Freedom is a very simple ruby web application framework.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'freedom'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install freedom
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/freedom. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/freedom/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Freedom project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/freedom/blob/master/CODE_OF_CONDUCT.md).

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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "freedom"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/freedom.gemspec

@@ -0,0 +1,31 @@
+require_relative "lib/freedom/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-freedom"
+  spec.version       = Freedom::VERSION
+  spec.authors       = ["unagiootoro"]
+  spec.email         = ["ootoro838861@outlook.jp"]
+
+  spec.summary       = %q{Tiny web application framework.}
+  spec.description   = %q{Freedom is a very simple ruby web application framework.}
+  spec.homepage      = "https://github.com/unagiootoro/freedom.git"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.add_dependency "rack"
+  spec.add_dependency "rack-protection"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  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", "<3.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "yard"
+end

data/lib/freedom.rb

@@ -0,0 +1,14 @@
+require "rack"
+require "rack-protection"
+require "uri"
+require "erb"
+require "logger"
+
+module Freedom; end
+
+require_relative "freedom/version"
+require_relative "freedom/core/application"
+require_relative "freedom/core/controller"
+require_relative "freedom/core/request"
+require_relative "freedom/core/response"
+require_relative "freedom/core/config"

data/lib/freedom/core/application.rb

@@ -0,0 +1,154 @@
+module Freedom
+  class BaseApplication
+    def initialize
+      @routing_table = {}
+      routes
+    end
+
+    def call(env)
+      req = Freedom::Request.new(env)
+      resolve(req)
+    end
+
+    def routes
+      raise NotImplementedError.new
+    end
+
+    def get(table_data)
+      route("GET", table_data)
+    end
+
+    def post(table_data)
+      route("POST", table_data)
+    end
+
+    def put(table_data)
+      route("PUT", table_data)
+    end
+
+    def delete(table_data)
+      route("DELETE", table_data)
+    end
+
+    def head(table_data)
+      route("HEAD", table_data)
+    end
+
+    def options(table_data)
+      route("OPTIONS", table_data)
+    end
+
+    def patch(table_data)
+      route("PATCH", table_data)
+    end
+
+    def link(table_data)
+      route("LINK", table_data)
+    end
+
+    def unlink(table_data)
+      route("UNLINK", table_data)
+    end
+
+    private
+
+    def route(http_method, table_data)
+      table_data.each do |path, controller_action|
+        controller_name, action_name = controller_action.split("#")
+        controller_class = Kernel.const_get(controller_name)
+        @routing_table[[http_method, path]] = [controller_class.new, action_name.to_sym]
+      end
+    end
+
+    def resolve(request)
+      result, match_data = match_routing_table(request)
+      if result
+        controller, action = *result
+        begin
+          res = controller.call(action, request)
+          res.finish
+        rescue => e
+          STDERR.puts e.full_message
+          status_500
+        end
+      else
+        if File.exist?("#{Dir.pwd}/#{Config.public_dir}#{request.path_info}")
+          files = Rack::Files.new(Config.public_dir)
+          files.get(request.env)
+        else
+          status_404
+        end
+      end
+    end
+
+    def match_routing_table(request)
+      @routing_table.each do |key, val|
+        http_method, path = *key
+        next unless http_method == request.request_method
+        if path.is_a?(String)
+          return [val, nil] if path == request.path_info
+        elsif path.is_a?(Regexp)
+          match_data = request.path_info.match(path)
+          return [val, match_data] if match_data
+        end
+      end
+      [nil, nil]
+    end
+
+    def status_404
+      res = Response.new(["404 Not Found"], 404)
+      res.finish
+    end
+
+    def status_500
+      res = Response.new(["500 Internal Server Error"], 500)
+      res.finish
+    end
+  end
+
+  class Application < BaseApplication
+    def self.start(options = {})
+      self.new(options).start
+    end
+
+    def initialize(options = {})
+      super()
+      @options = options.clone
+      @middlewares = default_middlewares
+      @rack_server = nil
+    end
+
+    def built?
+      !!@rack_server
+    end
+
+    def build
+      builder = Rack::Builder.new(self)
+      @middlewares.each do |middleware_array|
+        builder.use(*middleware_array)
+      end
+      rack_options = @options
+      rack_options[:app] = builder.to_app
+      rack_options[:Port] = 5700 unless rack_options[:Port]
+      @rack_server = Rack::Server.new(rack_options)
+    end
+
+    def start
+      build unless built?
+      @rack_server.start
+    end
+
+    def add_middleware(middleware_class, *middleware_args)
+      @middlewares << [middleware_class, *middleware_args]
+    end
+
+    private
+
+    def default_middlewares
+      [
+        [Rack::CommonLogger, ::Logger.new(Config.log_file_name)],
+        [Rack::Protection::PathTraversal],
+      ]
+    end
+  end
+end

data/lib/freedom/core/config.rb

@@ -0,0 +1,21 @@
+module Freedom
+  module Config
+    class << self
+      attr_accessor :public_dir
+      attr_accessor :views_dir
+      attr_accessor :controller_dir
+
+      attr_accessor :encoding
+
+      attr_accessor :log_file_name
+    end
+  end
+
+  Config.public_dir = "public"
+  Config.views_dir = "views"
+  Config.controller_dir = "controller"
+
+  Config.encoding = "UTF-8"
+
+  Config.log_file_name = "logfile.txt"
+end

data/lib/freedom/core/controller.rb

@@ -0,0 +1,80 @@
+module Freedom
+  class Controller
+    def initialize
+      @request = nil
+      @response = nil
+    end
+
+    def call(action, req)
+      @request = req
+      @response = Response.new(nil, 200)
+      catch(:halt) do
+        body = send(action)
+        return_plain
+      end
+      @response
+    end
+
+    def request
+      @request
+    end
+
+    def response
+      @response
+    end
+
+    def params
+      @request.params
+    end
+
+    def return_plain(body)
+      @response.content_type = "text/plain;charset=#{Config.encoding}"
+      halt(body: body)
+    end
+
+    def return_html(body)
+      @response.content_type = "text/html;charset=#{Config.encoding}"
+      halt(body: body)
+    end
+
+    def return_json(body)
+      @response.content_type = "application/json"
+      halt(body: body)
+    end
+
+    def html(name)
+      html = File.read("#{Config.views_dir}/#{name}.html")
+      return_html(html)
+    end
+
+    def erb(name)
+      html = ERB.new(File.read("#{Config.views_dir}/#{name}.erb", encoding: Config.encoding)).result(binding)
+      return_html(html)
+    end
+
+    def get_cookie(key)
+      @request.cookies[key]
+    end
+
+    def set_cookie(key, cookie)
+      hash = cookie.is_a?(String) ? { value: cookie} : cookie
+      @response.set_cookie(key, hash)
+    end
+
+    def url(path, scheme = nil)
+      scheme ||= @request.scheme
+      "#{scheme}://#{@request.domain + path}"
+    end
+
+    def redirect(uri)
+      @response.location = uri
+      halt status: 303
+    end
+
+    def halt(body: nil, status: 200)
+      @response.status = status if status
+      @response.body = [body] if body
+      throw :halt
+    end
+  end
+end

data/lib/freedom/core/request.rb

@@ -0,0 +1,27 @@
+module Freedom
+  class Request < Rack::Request
+    def initialize(env)
+      super(env)
+      @post_data = nil
+      @domain = nil
+      @scheme = nil
+    end
+
+    def post_data
+      return @post_data if @post_data
+      @post_data = body.read
+    end
+
+    def domain
+      return @domain if @domain
+      match_data = @env["REQUEST_URI"].match(/.+\:\/\/(.+?)\//)
+      @domain = match_data[1]
+    end
+
+    def scheme
+      return @scheme if @scheme
+      match_data = @env["REQUEST_URI"].match(/(.+)\:\/\//)
+      @scheme = match_data[1]
+    end
+  end
+end

data/lib/freedom/core/response.rb

@@ -0,0 +1,4 @@
+module Freedom
+  class Response < Rack::Response
+  end
+end

data/lib/freedom/version.rb

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

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: ruby-freedom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- unagiootoro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-protection
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Freedom is a very simple ruby web application framework.
+email:
+- ootoro838861@outlook.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- freedom.gemspec
+- lib/freedom.rb
+- lib/freedom/core/application.rb
+- lib/freedom/core/config.rb
+- lib/freedom/core/controller.rb
+- lib/freedom/core/request.rb
+- lib/freedom/core/response.rb
+- lib/freedom/version.rb
+homepage: https://github.com/unagiootoro/freedom.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Tiny web application framework.
+test_files: []