grande 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de0c0ef55381a0884ab038b4b1405a8b5853304ad02429e546c36b4e43560cfd
+  data.tar.gz: 5d6115b6cd99f6ea98230d9eb24f536c4a1b46906e6daf2b893aa7cdb4d8e8ea
+SHA512:
+  metadata.gz: 4d299ba2e4ab4e4c7b623331a1626d7b002d4dd54646340a719cc599b6ff009910ef38b2e43fefd0bb05743989f5d2ece64a6c1a47ee5e90be762140afe16322
+  data.tar.gz: 3130112b479bf4cc0d867a723266a9f0c8da2ac5055fe4c3f9e9b87fab49fc5d70bba237afc8d22b92134193df2fbaa2ca2044e4afcf51c7496408862e06b06d

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2021 André Diego Piske
+
+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,51 @@
+
+# Grande
+
+Grande is a small framework. The world surely needs more frameworks, so I went
+ahead and created this.
+
+# Get started
+
+Clone this repository and copy the _app\_template_ folder somewhere. This is going
+to be your app root folder. Then rename that folder to something truly awesome.
+
+Enter that folder and run:
+
+```
+$ bundle install
+$ bundle exec puma -p 3000
+```
+
+Then watch it say hello to the world by running:
+
+```
+$ curl http://localhost:3000/
+```
+
+🎉
+
+# Seriously tho
+
+I came across creating small apps in Ruby and I ended up always creating the same
+code again and again. So I to created this repo and now I can more quickly create
+new apps. It is both *batteries included* and *opinionated*, so beware!
+
+It includes:
+
+- Configuration loading
+- A `config.ru` and `config/puma.rb` with forking instructions
+- A Gemfile with decent default gems
+- An initial folder structure
+- Database setup with Sequel, PG and Redis, working out of the box with forking servers
+- A `public` folder to serve assets if there should be any
+- A rspec skeleton
+- Database migration folder structure and rake task. Specific for Sequel
+
+A good foundation for any app to start with in my opinion :-)
+
+The idea is to be simple, so there's no fancy scaffolding code. Instead, a folder
+(`app_template`) where one can just copy and paste it and change whatever is needed.
+
+# License
+
+Licensed under the [MIT license](MIT-LICENSE).

data/lib/grande.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'grande/version'

data/lib/grande/config_loader.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+require 'yaml'
+
+class Grande::ConfigLoader
+  def initialize
+    @conf = nil
+
+    default_path = File.join(Grande.c.app.root_path, 'config/config.yml')
+
+    if ENV.key?('GRANDE_CONFIG_PATH')
+      path = ENV['GRANDE_CONFIG_PATH']
+      if !File.exist?(path)
+        raise "GRANDE_CONFIG_PATH set but file does not exist. Either remove the env var or create the file"
+      end
+      Grande.logger.info("Loading configuration from #{path}")
+      load_conf_file!(path)
+    elsif File.exist?(default_path)
+      Grande.logger.info("Found config.yml at #{path}. Will load config from that")
+
+      load_conf_file!(default_path)
+    else
+      Grande.logger.info('Configuration file not provided. Loading all configuration from environment variables')
+    end
+  end
+
+  def get_int(key, default=nil)
+    value = get_str(key)
+    return default if value == nil
+    Integer(value)
+  end
+
+  def get_int!(key)
+    value = get_int(key)
+    raise "Config key #{key} is required" unless value
+    Integer(value)
+  end
+
+  def get_str(key, default=nil)
+    env_var_name = key_to_env_var_name(key)
+    return ENV[env_var_name] if ENV.key?(env_var_name)
+
+    parts = key.split('.')
+    base_obj = if parts.length == 1
+      @conf
+    else
+      @conf.dig(*parts[0...-1])
+    end
+
+    # binding.pry if key =="redis.url"
+
+    base_obj.fetch(parts.last, default)
+  end
+
+  def get_str!(key)
+    none = Object.new
+    value = get_str(key, none)
+    raise "Config key #{key} is required" if value == none
+
+    value
+  end
+
+  private
+
+  # Convert key format from foo.bar.qux
+  # into FOO_BAR_QUX
+  def key_to_env_var_name(key)
+    key.split('.').map(&:upcase).join('_')
+  end
+
+  def load_conf_file!(path)
+    @conf = YAML.safe_load(File.read(path))
+  end
+end

data/lib/grande/context.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Grande
+  def self.c
+    ::Grande::Context.instance
+  end
+
+  def self.logger
+    c.app.logger
+  end
+end
+
+class Grande::Context
+  attr_reader :app
+
+  def self.instance
+    @instance ||= new
+  end
+
+  def set_app(app)
+    raise "App can't be set twice" if @app
+    raise 'App can only be set if in booting phase' unless app.booting?
+
+    @app = app
+  end
+
+  # If one is using forking servers,
+  # this could should be run to re-setup all DB connections
+  def run_after_fork
+    @app.setup_db_connections
+  end
+end

data/lib/grande/environment.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'grande/version'
+require 'grande/config_loader'
+require 'grande/context'

data/lib/grande/use_redis.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal
+
+require 'redis'
+require 'connection_pool'
+
+module Grande::UseRedis
+  attr_reader :redis_pool
+
+  def setup_redis_connection
+    pool_size = @config_loader.get_int('redis.pool.size', 4)
+    pool_timeout = @config_loader.get_int('redis.pool.timeout', 5)
+    redis_url = @config_loader.get_str!('redis.url')
+
+    Grande.logger.info("Using redis at #{redis_url}")
+
+    @redis_pool = ConnectionPool.new(size: pool_size, timeout: pool_timeout) do
+      Redis.new(url: redis_url)
+    end
+  end
+end

data/lib/grande/use_sequel.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'sequel'
+
+module Grande::UseSequel
+end

data/lib/grande/use_sequel_with_pg.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative './use_sequel'
+require 'pg'
+
+module Grande::UseSequel
+  attr_reader :db
+
+  def setup_sequel_connection
+    db_url = @config_loader.get_str!("database.url")
+    @db = Sequel.connect(db_url)
+    @db.extension(:pg_json)
+  end
+end

data/lib/grande/use_sinatra.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal
+
+require 'sinatra'
+require 'sinatra/namespace'

data/lib/grande/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Grande
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: grande
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- André D. Piske
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-23 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      Opinionated starting point for creating ruby apps.
+      Designed to create APIs or Web apps.
+email: andrepiske@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/grande.rb
+- lib/grande/config_loader.rb
+- lib/grande/context.rb
+- lib/grande/environment.rb
+- lib/grande/use_redis.rb
+- lib/grande/use_sequel.rb
+- lib/grande/use_sequel_with_pg.rb
+- lib/grande/use_sinatra.rb
+- lib/grande/version.rb
+homepage: https://github.com/andrepiske/grande
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Superpower your small but grande app
+test_files: []