makanai 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c35e25ab94dce7eb78c2e81cd7d1086ba736c81d99ba81c17ae85cfaa88dcd25
-  data.tar.gz: fa52e627e552253a97ce59065ab456406e75901667c093fb7c160ac243bb5a35
+  metadata.gz: 50ec7b4b39d4f324b5bb6d2c36c0f9f03274fd5b224862b4142d28cde7950a0f
+  data.tar.gz: d3b3716c39366f43b142c67f82ab7763ce6b65d07e3ef19a40347a56c71920a7
 SHA512:
-  metadata.gz: 8b2661b6a8e5df30a371e60ad9123b3814df7db48f02c91a2eae1e3e2acb3961b711aa5880aa70c103b0d78345ffbd9e4b097196e519e12821dd81951c554552
-  data.tar.gz: 0b91f2e2a8a3a03406506d8323ff05dccd22be62bf1d5ddb254b32771b8f99488094457bde8d5dd63367d73ac325d7d41a0e0d930ba4e5d7da75127e93118ab2
+  metadata.gz: 181e579b7e1d48853f06756c1f23f74b4ed15bcc083ac504df6fc716010ce99b3552216ebea3854a484a35256d6e7ef69031c2b8cc11c5d5c6165fcef3e53bc0
+  data.tar.gz: ed57e62dabd988e754728cd7677bfb397e1836bd499cde76ebaed7ccc27849e728fed84b473eb325ba7cb5e527d97a52cdcdf4cef183df4cb295f348827efae3

data/.travis.yml

@@ -2,6 +2,13 @@
 sudo: false
 language: ruby
 cache: bundler
+services:
+  - postgresql
+  - mysql
 rvm:
   - 2.7.0
-before_install: gem install bundler -v 2.0.2
+before_install:
+  - gem install bundler -v 2.0.2
+  - mysql -e 'CREATE DATABASE IF NOT EXISTS makanai;'
+before_script:
+  - psql -c 'create database makanai;' -U postgres

data/CHANGELOG.md

@@ -19,3 +19,8 @@
   Changed the setting so that it is retained by the Class variable, and made it configurable.
   The big advantage is that you can use any web server(ex. puma) except WEBrick.  
   https://github.com/Madogiwa0124/makanai/pull/18/commits/e6ea10e596c685ef77c042fa1e8f0294c85166f2
+
+## :gift: 2020/03/04 `v0.1.3` released.
+* :sparkles: Multiple DBMS available.  
+  you can use dbms(MySQL :dolphin:, PostgreSQL :elephant:) other then SQLite.  
+  https://github.com/Madogiwa0124/makanai/pull/19

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    makanai (0.1.2)
+    makanai (0.1.3)
       rack (>= 2.0.7, < 2.3.0)
       rake (>= 10, < 14)
       sqlite3 (~> 1.4.1)
@@ -12,9 +12,11 @@ GEM
     ast (2.4.0)
     diff-lcs (1.3)
     jaro_winkler (1.5.4)
+    mysql2 (0.5.3)
     parallel (1.19.1)
-    parser (2.7.0.2)
+    parser (2.7.0.4)
       ast (~> 2.4.0)
+    pg (1.2.2)
     rack (2.2.2)
     rainbow (3.0.0)
     rake (13.0.1)
@@ -32,7 +34,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.0)
-    rubocop (0.80.0)
+    rubocop (0.80.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
@@ -50,6 +52,8 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   makanai!
+  mysql2 (~> 0.5)
+  pg (~> 1.2)
   rspec (~> 3.0)
   rubocop (~> 0.74)
 

data/README.md

@@ -47,7 +47,7 @@ $ ruby app.rb
 create a ruby ​​file(ex. app.rb).
 
 ``` ruby
-require_relative '../lib/main.rb'
+require 'makanai/main'
 
 router.get '/' do
   'Hello Makanai!'
@@ -100,6 +100,26 @@ 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
+
+install dbms(postgresql, mysql, sqlite). And add dbms gem (ex. pg) in your Gemfile.
+
+``` ruby
+gem 'pg'
+```
+
+Overwrite the `databse_client` and `databse_config` with the created ruby ​​file(ex. app.rb) and Rakefile.
+
+``` ruby
+Makanai::Settings.databse_client = :postgres
+Makanai::Settings.databse_config = {
+  host: 'localhost',
+  password:'password',
+  dbname: 'makanai',
+  port: 5432
+}
+```
+
 ## routing
 
 ``` ruby
@@ -172,7 +192,7 @@ Create an erb file in `src/views` with the name specified in render.
 
 ## migration
 
-makanai uses `sqlite3` as db. create db and migrate schema when executed `rake makanai:db:migration`.
+migrate schema when executed `rake makanai:db:migration`.
 
 ```
 # execute all migraiton sql
@@ -239,6 +259,22 @@ Resource.find(1).delete
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Madogiwa0124/makanai. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+## setup develop enviroment
+
+Use docker-compose to build `mysql` and` postgres` containers for development.
+
+``` sh
+$ docker-compose up -d
+Creating makanai_mysql_1    ... done
+Creating makanai_postgres_1 ... done
+
+$ docker-compose ps
+       Name                     Command              State                 Ports
+----------------------------------------------------------------------------------------------
+makanai_mysql_1      docker-entrypoint.sh mysqld     Up      0.0.0.0:3306->3306/tcp, 33060/tcp
+makanai_postgres_1   docker-entrypoint.sh postgres   Up      0.0.0.0:5432->5432/tcp
+```
+
 # License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/docker-compose.yml

@@ -0,0 +1,14 @@
+mysql:
+  image: mysql
+  ports:
+    - 3306:3306
+  environment:
+    - MYSQL_DATABASE=makanai
+    - MYSQL_ALLOW_EMPTY_PASSWORD=yes
+postgres:
+  image: postgres
+  ports:
+    - 5432:5432
+  environment:
+    - POSTGRES_USER=makanai
+    - POSTGRES_PASSWORD=password

data/lib/makanai/database.rb

@@ -1,27 +1,31 @@
 # frozen_string_literal: true
 
-require 'sqlite3'
+require_relative './dbms/sqlite.rb'
 require_relative './settings.rb'
 
 module Makanai
   class Database
-    def initialize(path: Settings.database_full_path)
-      @handler = SQLite3::Database
-      @db = handler.new path
-      db.tap { |db| db.results_as_hash = true }
+    class UnsupportedException < StandardError; end
+
+    def initialize(client: Settings.databse_client, config: Settings.databse_config)
+      client_class = client_class(client)
+      @client = client_class.new(config)
     end
 
-    attr_reader :handler, :db
+    attr_reader :client
 
     def execute_sql(sql)
       puts "SQL: #{sql.gsub("\n", ' ')}"
-      db.execute(sql).tap { close_db }
+      client.execute_sql(sql)
     end
 
     private
 
-    def close_db
-      db.close
+    def client_class(client)
+      require_relative File.join('dbms', client.to_s)
+      Object.const_get("Makanai::Dbms::#{client.capitalize}")
+    rescue LoadError
+      raise UnsupportedException
     end
   end
 end

data/lib/makanai/dbms/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Makanai
+  module Dbms
+    class Base
+      def db
+        raise NotImplementedError
+      end
+
+      def execute_sql
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/makanai/dbms/mysql.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'mysql2'
+require_relative './base.rb'
+module Makanai
+  module Dbms
+    class Mysql < Base
+      def initialize(config)
+        @db = Mysql2::Client.new(config || default_config)
+      end
+
+      attr_reader :db
+
+      def execute_sql(sql)
+        db.query(sql).to_a.tap { close_db }
+      end
+
+      private
+
+      def default_config
+        {
+          host: '0.0.0.0',
+          username: 'root',
+          password: 'password',
+          database: 'makanai',
+          port: 3306
+        }
+      end
+
+      def close_db
+        db.close
+      end
+    end
+  end
+end

data/lib/makanai/dbms/postgres.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'pg'
+require_relative './base.rb'
+module Makanai
+  module Dbms
+    class Postgres < Base
+      def initialize(config)
+        @db = PG.connect(config || default_config)
+        db.type_map_for_results = PG::BasicTypeMapForResults.new(db)
+      end
+
+      attr_reader :db
+
+      def execute_sql(sql)
+        db.exec(sql).each.to_a.tap { close_db }
+      end
+
+      private
+
+      def default_config
+        {
+          host: 'localhost',
+          password: nil,
+          dbname: 'makanai',
+          port: 5432
+        }
+      end
+
+      def close_db
+        db.finish
+      end
+    end
+  end
+end

data/lib/makanai/dbms/sqlite.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'sqlite3'
+require_relative './base.rb'
+module Makanai
+  module Dbms
+    class Sqlite < Base
+      def initialize(config)
+        @db = SQLite3::Database.new(config[:path])
+        db.tap { |db| db.results_as_hash = true }
+      end
+
+      attr_reader :db
+
+      def execute_sql(sql)
+        db.execute(sql).tap { close_db }
+      end
+
+      private
+
+      def close_db
+        db.close
+      end
+    end
+  end
+end

data/lib/makanai/rake_tasks.rb

@@ -29,7 +29,7 @@ namespace :makanai do
         sql_paths = Dir.glob("#{migration_root_path}*")
         sql_paths.each { |sql_path| execute_sql(sql_path: sql_path) }
       else
-        execute_sql(sql_path: "#{migration_root_path}#{target}")
+        execute_sql(sql_path: File.join(migration_root_path, target))
       end
       puts "INFO: finished migration #{ENV['target']}"
     end

data/lib/makanai/settings.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'rack'
+require_relative './dbms/sqlite.rb'
+require_relative './dbms/postgres.rb'
 
 module Makanai
   class Settings
@@ -16,12 +18,37 @@ module Makanai
     @migration_root_path = DEFAULT_MIGRATION_ROOT_PATH
     @rack_app_config = DEFAULT_RACK_APP_CONFIG
 
+    # NOTE: Use Sqlite3
+    @databse_client = :sqlite
+    @databse_config = { path: File.join(@app_root_path, @database_path) }
+
+    # NOTE: Use Postgresql
+    # @databse_client = :postgres
+    # @databse_config = {
+    #   host: 'localhost',
+    #   password: 'password',
+    #   dbname: 'makanai',
+    #   port: 5432
+    # }.freeze
+
+    # NOTE: Use MySQL
+    # @databse_client = :mysql
+    # @databse_config = {
+    #   host: 'localhost',
+    #   username: 'root',
+    #   password: 'password',
+    #   database: 'makanai',
+    #   port: 3306
+    # }.freeze
+
     class << self
       attr_accessor :app_root_path,
                     :database_path,
                     :template_root_path,
                     :migration_root_path,
-                    :rack_app_config
+                    :rack_app_config,
+                    :databse_client,
+                    :databse_config
 
       def database_full_path
         File.join(app_root_path, database_path)

data/lib/makanai/version.rb

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

data/makanai.gemspec

@@ -31,4 +31,6 @@ Gem::Specification.new do |spec|
   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"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: makanai
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Madogiwa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-22 00:00:00.000000000 Z
+date: 2020-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -106,6 +106,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 description: simple web application framework for learning.
 email:
 - madogiwa0124@gmail.com
@@ -127,10 +155,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - exe/makanai
 - lib/makanai.rb
 - lib/makanai/application.rb
 - lib/makanai/database.rb
+- lib/makanai/dbms/base.rb
+- lib/makanai/dbms/mysql.rb
+- lib/makanai/dbms/postgres.rb
+- lib/makanai/dbms/sqlite.rb
 - lib/makanai/dsl.rb
 - lib/makanai/generator.rb
 - lib/makanai/generator/application/directories.yaml