makanai 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c81e0de73a48146dc929239f380cba64b004c3517e9efc6f005d2c6a1f29f49
-  data.tar.gz: be85163a11c4e40cc0f3a43b122ce6396674dccb7fcd4bc14339888c9f45ef39
+  metadata.gz: 8c7b32701bd75c6ea7cae7f893310a50e5e70a9fea7c14e9a99ba9559b2e7a39
+  data.tar.gz: 8890f0956507a1d0bfa92197718f40b4ed7da313737fe4501032565154f68e08
 SHA512:
-  metadata.gz: ebf556b401b54ee54b7921d907e324c03f5926f780c3fe9f39881d6a59a9727cb4d742f8f8f85fe4006626b24bad64b6c262c9725cb7fc31108f0861703c2f44
-  data.tar.gz: 5174bf19553fd347e15b27469e63224f1552288912b150f739f5b251f63227da3f3a88a408c2e305ecde170d0ee2aa1dc60f5750a765a398c8a32b9f1a769d9a
+  metadata.gz: 268af34e32c0cfd48753227a04bf604f6b1fe3fae0a2ef4bb709965c8d6ac73ec3b78a6c6813a2576c33e69e9c00506d60ef1edecd8fd4046bdb013f96081574
+  data.tar.gz: d112687c6207e860f5c0513f2530c26c0d388472d3058aae069dc98771c7e637636ef61dfb2300727fa7952c8d03d018d3649b7d086a3b395d98a4c33bb2e8eb

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.7.0
+  NewCops: enable
   Exclude:
     - './makanai.gemspec'
     - 'vendor/**/*'

data/.travis.yml

@@ -14,7 +14,11 @@ before_install:
   - gem install bundler -v 2.1.4
   - mysql -e 'CREATE DATABASE IF NOT EXISTS makanai;'
 before_script:
+  - psql -c "create user makanai WITH PASSWORD 'password';" -U postgres
   - psql -c 'create database makanai;' -U postgres
+script:
+  - bundle exec rubocop --parallel
+  - bundle exec rspec
 jobs:
   allow_failures:
     - rvm: ruby-head

data/CHANGELOG.md

@@ -39,3 +39,10 @@
 
 ## :gift: 2020/06/16 `v0.1.5` released.
 * :package: dependency update.
+
+## :gift: 2020/08/07 `v0.1.6` released.
+* :sparkles: enabled to switch template engine Haml and ERB.  
+  https://github.com/Madogiwa0124/makanai/commit/b9f977fe9e974aa1abbf2764a2fdad989e2767ec
+
+* :zap: remove sqlite3 from runtime_dependency.  
+  https://github.com/Madogiwa0124/makanai/commit/d63c3b12cf6fc412a8d88806dca9710e210e5fe0

data/Gemfile

@@ -6,4 +6,4 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
 
-gem 'codecov', :require => false
+gem 'codecov', require: false

data/Gemfile.lock

@@ -1,26 +1,29 @@
 PATH
   remote: .
   specs:
-    makanai (0.1.5)
+    makanai (0.1.6)
       rack (>= 2.0.7, < 2.3.0)
       rake (>= 10, < 14)
-      sqlite3 (~> 1.4.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    codecov (0.1.17)
+    ast (2.4.1)
+    codecov (0.2.3)
+      colorize
       json
       simplecov
-      url
+    colorize (0.8.1)
     diff-lcs (1.3)
     docile (1.3.2)
-    json (2.3.0)
+    haml (5.1.2)
+      temple (>= 0.8.0)
+      tilt
+    json (2.3.1)
     mysql2 (0.5.3)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     pg (1.2.3)
     rack (2.2.3)
     rainbow (3.0.0)
@@ -40,25 +43,26 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    rubocop (0.85.1)
+    rubocop (0.89.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.0.3)
+      rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
     ruby-progressbar (1.10.1)
     simplecov (0.18.5)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.2)
     sqlite3 (1.4.2)
+    temple (0.8.2)
+    tilt (2.0.10)
     unicode-display_width (1.7.0)
-    url (0.3.2)
 
 PLATFORMS
   ruby
@@ -66,11 +70,13 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   codecov
+  haml (~> 5.0)
   makanai!
   mysql2 (~> 0.5)
   pg (~> 1.2)
   rspec (~> 3.0)
   rubocop (~> 0.74)
+  sqlite3 (~> 1.4.1)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -24,12 +24,6 @@ Or install it yourself as:
 
     $ gem install makanai
 
-## Dependencies
-
-Makanai depends on the following, so please install it in advance.
-
-* [SQLite3](https://www.sqlite.org/index.html)
-
 ## Start sample project
 Getting started with Makanai is easy.
 
@@ -101,9 +95,11 @@ Overwrite the `handler` in `rack_app_config` with the created ruby ​​file(ex
 Makanai::Settings.rack_app_config = { handler: :puma, host: '0.0.0.0', port: '8080' }
 ```
 
-### use other dbms
+### use dbms
+
+Makanai use `sqlite` by default, and make `db/makanai.db`.
 
-install dbms(postgresql, mysql, sqlite). And add dbms gem (ex. pg) in your Gemfile.
+If you use another dbms, install dbms(PostgreSQL or MySQL). And add dbms gem (`pg` or `mysql2`) in your Gemfile.
 
 ``` ruby
 gem 'pg'
@@ -169,22 +165,33 @@ router.delete '/resources' do |request|
 end
 ```
 
-## erb render
+## rendering
 
-Define instance variables used in the routing view.
+Define instance variables used in the routing view. And specify template engine(`ERB` or `Haml`).
 
 ``` ruby
 require 'makanai/main'
 
+# setting template engine(default: :erb).
+Makanai::Settings.template_engine = :haml
+
 router.get '/index' do
   @title = 'Makanai title'
   @body = 'Makanai body'
-  render :index
+  render :index # render default template engine.
+end
+
+router.get '/index' do
+  @title = 'Makanai title'
+  @body = 'Makanai body'
+  render :index, :haml # render specified template engine.
 end
 ```
 
 Create an erb file in `src/views` with the name specified in render.
 
+erb
+
 ``` html
 <!-- src/views/index.erb -->
 <html>
@@ -198,6 +205,19 @@ Create an erb file in `src/views` with the name specified in render.
 </html>
 ```
 
+haml
+
+``` haml
+!!!
+%html
+  %head
+    %meta{:content => "text/html; charset=UTF-8", "http-equiv" => "Content-Type"}/
+    %meta{:charset => "UTF-8"}/
+    %title= @title
+  %body
+    = @body
+```
+
 ## migration
 
 migrate schema when executed `rake makanai:db:migration`.

data/lib/makanai/application.rb

@@ -3,10 +3,10 @@
 require 'json'
 require 'uri'
 require 'rack'
-require_relative './settings.rb'
-require_relative './request.rb'
-require_relative './response.rb'
-require_relative './router.rb'
+require_relative './settings'
+require_relative './request'
+require_relative './response'
+require_relative './router'
 
 module Makanai
   class Application

data/lib/makanai/database.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './dbms/sqlite.rb'
-require_relative './settings.rb'
+require_relative './settings'
 
 module Makanai
   class Database

data/lib/makanai/dbms/mysql.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require 'mysql2'
-require_relative './base.rb'
+require_relative './base'
 module Makanai
   module Dbms
     class Mysql < Base
       def initialize(config)
+        super()
         @db = Mysql2::Client.new(config || default_config)
       end
 

data/lib/makanai/dbms/postgres.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require 'pg'
-require_relative './base.rb'
+require_relative './base'
 module Makanai
   module Dbms
     class Postgres < Base
       def initialize(config)
+        super()
         @db = PG.connect(config || default_config)
         db.type_map_for_results = PG::BasicTypeMapForResults.new(db)
       end

data/lib/makanai/dbms/sqlite.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 require 'sqlite3'
-require_relative './base.rb'
+require_relative './base'
 module Makanai
   module Dbms
     class Sqlite < Base
       def initialize(config)
+        super()
         @db = SQLite3::Database.new(config[:path])
         db.tap { |db| db.results_as_hash = true }
       end

data/lib/makanai/dsl.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
-require_relative './template.rb'
-require_relative './response.rb'
-require_relative './settings.rb'
+require_relative './template'
+require_relative './response'
+require_relative './settings'
 
-def render(path)
+def render(path, engine = Makanai::Settings.template_engine)
   template_root_path = Makanai::Settings.template_full_path
-  full_path = File.join(template_root_path, "#{path}.erb")
-  Makanai::Template.new(path: full_path).render
+  full_path = File.join(template_root_path, path.to_s)
+  # NOTE: Get all instance variables in main by Hash
+  locals = instance_variables.map { |name| [name, instance_variable_get(name)] }.to_h
+  Makanai::Template.new(path: full_path, engine: engine, locals: locals).render
 end
 
 def redirect_to(url)

data/lib/makanai/generator.rb

@@ -2,7 +2,7 @@
 
 require 'erb'
 require 'yaml'
-require_relative '../makanai.rb'
+require_relative '../makanai'
 
 module Makanai
   class Generator
@@ -10,6 +10,7 @@ module Makanai
     DIRECTORY_NAMES = YAML.load_file("#{ROOT_PATH}/application/directories.yaml")
     APP_TEMPLATE = File.read("#{ROOT_PATH}/application/templates/app.erb")
     RAKEFILE_TEMPLATE = File.read("#{ROOT_PATH}/application/templates/rakefile.erb")
+    GEMFILE_TEMPLATE = File.read("#{ROOT_PATH}/application/templates/gemfile.erb")
 
     def initialize(path = Dir.pwd)
       @path = path
@@ -39,6 +40,12 @@ module Makanai
       end
     end
 
+    def create_gemfile(template = GEMFILE_TEMPLATE)
+      File.join(path, 'Gemfile').tap do |file_path|
+        create_file(file_path, ERB.new(template).result)
+      end
+    end
+
     private
 
     def create_file(file_path, content)

data/lib/makanai/generator/application/templates/gemfile.erb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+gem 'makanai'
+gem 'sqlite3'

data/lib/makanai/main.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative './application.rb'
-require_relative './router.rb'
-require_relative './dsl.rb'
+require_relative './application'
+require_relative './router'
+require_relative './dsl'
 
 def router
   @router ||= Makanai::Router.new

data/lib/makanai/migration.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative './settings.rb'
-require_relative './database.rb'
+require_relative './settings'
+require_relative './database'
 
 module Makanai
   module Migration

data/lib/makanai/model.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './database.rb'
+require_relative './database'
 
 module Makanai
   class Model

data/lib/makanai/rake_tasks.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
 require 'rake'
-require 'sqlite3'
-require_relative './migration.rb'
-require_relative './generator.rb'
+require_relative './migration'
+require_relative './generator'
 
 namespace :makanai do
   namespace :initialize do
@@ -14,6 +13,7 @@ namespace :makanai do
       puts generator.create_app_directories
       puts generator.create_app_rb
       puts generator.create_rakefile
+      puts generator.create_gemfile
       puts 'INFO: finished ganerate app'
     end
   end
@@ -25,6 +25,7 @@ namespace :makanai do
 
       puts "INFO: start migration #{ENV['target']}"
       target = ENV['target']
+      pp migration_root_path
       if target == 'all'
         sql_paths = Dir.glob("#{migration_root_path}*")
         sql_paths.each { |sql_path| execute_sql(sql_path: sql_path) }

data/lib/makanai/settings.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require 'rack'
-require_relative './dbms/sqlite.rb'
-require_relative './dbms/postgres.rb'
 
 module Makanai
   class Settings
@@ -11,10 +9,12 @@ module Makanai
     DEFAULT_TEMPLATE_ROOT_PATH = '/views/'
     DEFAULT_MIGRATION_ROOT_PATH = '/migration/'
     DEFAULT_RACK_APP_CONFIG = { handler: :webrick, host: '0.0.0.0', port: '8080' }.freeze
+    DEFAULT_TEMPLATE_ENGINE = :erb
 
     @app_root_path = DEFAULT_APP_ROOT_PATH
     @database_path = DEFAULT_DATABASE_PATH
     @template_root_path = DEFAULT_TEMPLATE_ROOT_PATH
+    @template_engine = DEFAULT_TEMPLATE_ENGINE
     @migration_root_path = DEFAULT_MIGRATION_ROOT_PATH
     @rack_app_config = DEFAULT_RACK_APP_CONFIG
 
@@ -45,6 +45,7 @@ module Makanai
       attr_accessor :app_root_path,
                     :database_path,
                     :template_root_path,
+                    :template_engine,
                     :migration_root_path,
                     :rack_app_config,
                     :databse_client,

data/lib/makanai/template.rb

@@ -1,18 +1,29 @@
 # frozen_string_literal: true
 
-require 'erb'
-
 module Makanai
   class Template
-    def initialize(path:)
+    class UnsupportedException < StandardError; end
+
+    def initialize(path:, engine: :erb, locals: {})
       @path = path
+      @engine = engine
+      @locals = locals
     end
 
-    attr_reader :path
+    attr_reader :path, :engine, :locals
 
     def render
-      template_file = File.read(path)
-      ERB.new(template_file).result
+      template_file = File.read("#{path}.#{engine}")
+      engine_class.new(text: template_file, locals: locals).result
+    end
+
+    private
+
+    def engine_class
+      require_relative File.join('template_engine', engine.to_s)
+      Object.const_get("Makanai::TemplateEngine::#{engine.capitalize}")
+    rescue LoadError
+      raise UnsupportedException
     end
   end
 end

data/lib/makanai/template_engine/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Makanai
+  module TemplateEngine
+    class Base
+      def result
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/makanai/template_engine/erb.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'ostruct'
+require_relative './base'
+
+module Makanai
+  module TemplateEngine
+    class Erb < Base
+      def initialize(text:, locals: {})
+        super()
+        @text = text
+        @locals = locals
+      end
+
+      attr_reader :text, :locals
+
+      def result
+        # NOTE: ERB is need to pass the binding.
+        # So, pass the binding of the object that defined the instance variable.
+        # ref: https://docs.ruby-lang.org/en/2.7.0/ERB.html#method-i-result
+        ERB.new(text).result(Locals.new(locals).self_binding)
+      end
+      class Locals
+        def initialize(locals)
+          locals.each { |key, val| instance_variable_set(key, val) }
+        end
+
+        def self_binding
+          binding
+        end
+      end
+
+      private_constant :Locals
+    end
+  end
+end

data/lib/makanai/template_engine/haml.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'haml'
+require_relative './base'
+
+module Makanai
+  module TemplateEngine
+    class Haml < Base
+      def initialize(text:, locals: {})
+        super()
+        @text = text
+        @locals = locals
+      end
+
+      attr_reader :text, :locals
+
+      def result
+        # ref: http://haml.info/docs/yardoc/Haml/Engine.html#render-instance_method
+        ::Haml::Engine.new(text).render(Object.new, locals)
+      end
+    end
+  end
+end

data/lib/makanai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Makanai
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

data/makanai.gemspec

@@ -27,10 +27,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rake", ">= 10", "< 14"
   spec.add_dependency "rack", ">= 2.0.7", "< 2.3.0"
-  spec.add_dependency "sqlite3", "~> 1.4.1"
+  spec.add_development_dependency "sqlite3", "~> 1.4.1"
   spec.add_development_dependency "rubocop", "~> 0.74"
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pg", "~> 1.2"
   spec.add_development_dependency "mysql2", "~> 0.5"
+  spec.add_development_dependency "haml", "~> 5.0"
 end

data/sample/Rakefile

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'makanai/rake_tasks.rb'
+require 'makanai/rake_tasks'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: makanai
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Madogiwa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-16 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -57,7 +57,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.1
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -134,6 +134,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: haml
+  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'
 description: simple web application framework for learning.
 email:
 - madogiwa0124@gmail.com
@@ -169,6 +183,7 @@ files:
 - lib/makanai/generator.rb
 - lib/makanai/generator/application/directories.yaml
 - lib/makanai/generator/application/templates/app.erb
+- lib/makanai/generator/application/templates/gemfile.erb
 - lib/makanai/generator/application/templates/rakefile.erb
 - lib/makanai/main.rb
 - lib/makanai/migration.rb
@@ -179,6 +194,9 @@ files:
 - lib/makanai/router.rb
 - lib/makanai/settings.rb
 - lib/makanai/template.rb
+- lib/makanai/template_engine/base.rb
+- lib/makanai/template_engine/erb.rb
+- lib/makanai/template_engine/haml.rb
 - lib/makanai/version.rb
 - makanai.gemspec
 - sample/Rakefile