dandy 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35729ef648356d307df4cbb9a49aa1df7e053949
+  data.tar.gz: 695e1200d2c7066ed4f989842322437c5635779b
+SHA512:
+  metadata.gz: 52323c799596e094a5f2dd26a3a0b178f5016696fa4cd7cf33b0df4add8209f5fda43e908cdd1cfa26024bca443f599e048ecd7f17d85def852a3797e111b71b
+  data.tar.gz: 37757ebdc264e506788c398c0c525dac7f2b2cd882b27501283434faa8b0c60beeb813b85eb885eecacdac0f904e54f0bc34d35c527f725d1854c9275b4bada5

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.ruby-gemset
+.ruby-version
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dandy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Vladimir Kalinkin
+
+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,134 @@
+# Dandy
+
+Dandy is a minimalistic web API framework. Its main idea is to implement an approach 
+from Clean Architecture principles - "web is just a delivery mechanism". 
+Dandy is build on top of IoC container Hypo and forces to use dependency injection 
+approach everywhere.  
+
+## Basic Concepts
+
+1. [Dependency Injection](https://en.wikipedia.org/wiki/Dependency_injection) is a heart of Dandy. Atomic actions can depend on request parameters, services, repositories, output of other 
+actions and other stuff. You can easily inject such dependencies in your actions through a constructor. 
+Dependency Injection significantly improves development experience: isolate your components, enjoy writing unit tests.
+
+```ruby
+class LoadPost
+  def initialize(id, post_storage)
+    @id = id
+    @storage = post_storage
+  end
+  
+  def call
+    @storage.find(@id)
+  end
+end
+```     
+
+2. Instead of boring Ruby block-style routes definition like in Rails, Sinatra and others Dandy uses its 
+own language for that. Small example:
+
+```
+:receive
+    .->
+        :before -> user@load_current_user          
+        /posts ->
+            $id ->
+                :before -> load_post
+                /comments ->
+                    POST -> add_comment -> notify_author -> notify_subscribers -> :respond <- comment_test =201
+:catch -> handle_errors
+```
+
+3. The combination of flexible router and dependency injection breaks existing dogmas. 
+Dandy framework introduces Abstract Chain pattern as a replacement for Model-View-Controller 
+and other ancient approaches. Every request handles by a set of atomic actions. 
+
+```
+    # POST /posts/$id/comments
+    ... -> load_post -> add_comment -> ... 
+``` 
+
+```ruby
+class LoadPost
+  def initialize(id, post_storage)
+    @id = id
+    @storage = post_storage
+  end
+  
+  def call
+    @storage.find(@id)
+  end
+  
+  def result_name
+    'post'
+  end 
+end
+
+class AddComment
+  def initialize(post, dandy_data, user, comment_storage)
+    @post = post
+    @data = dandy_data
+    @user = user
+    @storage = comment_storage 
+  end
+  
+  def call
+    @storage.create(post: @post, message: @data[:message], user: @user)
+  end  
+end
+```
+
+4. Dandy is a micro-framework for micro-services. It's not intended to create monolithic giants! 
+In terms of [Domain Driven Design](https://en.wikipedia.org/wiki/Domain-driven_design) 
+concepts one Dandy application should wrap only one [Bounded Context](https://en.wikipedia.org/wiki/Domain-driven_design#Bounded_context).
+
+## Getting Started
+
+1. Install Dandy: 
+
+```
+    $ gem install dandy
+```
+
+2. At the command prompt, create a new Dandy application:
+
+```
+    $ dandy new dandy-app
+```
+
+3. Go to directory `dandy-app` and start the application using a server you prefer:
+
+```
+    $ puma -p 8000 config.ru
+```
+
+or just
+
+```
+    $ rackup -p 8000 config.ru
+```
+
+4. Using a browser, go to http://localhost:8000 and you'll see: 
+
+```json
+  {"message": "Welcome to dandy-app!"}
+```
+
+5. Investigate example application code, it will explain most of Dandy aspects.
+6. For more details visit our [Wiki](https://github.com/cylon-v/dandy/wiki).
+
+## Development
+
+Usual, but always helpful steps:
+ 
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/cylon-v/dandy.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'dandy'
+
+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/dandy.gemspec

@@ -0,0 +1,46 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dandy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dandy'
+  spec.version       = Dandy::VERSION
+  spec.authors       = ['Vladimir Kalinkin']
+  spec.email         = ['vova.kalinkin@gmail.com']
+
+  spec.summary       = 'Dandy is a minimalistic web API framework.'
+  spec.description   = 'The philosophy of Dandy is to provide minimalistic' \
+                       ' middleware between your model and API client.'
+
+  spec.homepage      = 'https://github.com/cylon-v/dandy'
+  spec.license       = 'MIT'
+
+  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 = `git ls-files -z`.split("\x0").reject do |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_dependency 'hypo', '~> 0.8.5'
+  spec.add_dependency 'rack', '~> 2.0.3'
+  spec.add_dependency 'thor', '~> 0.20.0'
+  spec.add_dependency 'treetop', '~> 1.6.8'
+  spec.add_dependency 'jbuilder', '~> 2.7.0'
+  spec.add_dependency 'rack-parser', '~> 0.7.0'
+  spec.add_dependency 'terminal-table', '~> 1.8.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-mocks', '~> 3.6'
+  spec.add_development_dependency  'simplecov', '~> 0.15'
+end

data/exe/dandy

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'dandy/generators/cli'
+
+Dandy::CLI.start ARGV

data/lib/dandy.rb

@@ -0,0 +1,6 @@
+require 'dandy/version'
+require 'dandy/app'
+require 'dandy/base/handle_errors'
+
+module Dandy
+end

data/lib/dandy/app.rb

@@ -0,0 +1,93 @@
+require 'hypo'
+require 'json'
+require 'rack/parser'
+require 'dandy/loaders/type_loader'
+require 'dandy/loaders/dependency_loader'
+require 'dandy/loaders/template_loader'
+require 'dandy/config'
+require 'dandy/request'
+require 'dandy/template_registry'
+require 'dandy/view_builder_registry'
+require 'dandy/view_factory'
+require 'dandy/chain_factory'
+require 'dandy/view_builders/json'
+require 'dandy/routing/routing'
+
+module Dandy
+  class App
+    attr_reader :routes
+
+    def initialize(container = Hypo::Container.new)
+      @container = container
+
+      register_dependencies
+      load_basic_dependencies
+      parse_routes
+      add_view_builders
+    end
+
+    def call(env)
+      request = Request.new(@route_matcher, @container, @chain_factory, @view_factory)
+      request.handle(env)
+    end
+
+    protected
+
+    def add_view_builder(view_builder, format)
+      @view_builder_registry.add(view_builder, format)
+    end
+
+    private
+
+    def add_view_builders
+      add_view_builder(ViewBuilders::Json, 'json')
+    end
+
+    def register_dependencies
+      instances = {
+        config_file_path: 'dandy.yml',
+        dandy_env: ENV['DANDY_ENV'] || 'development'
+      }
+
+      instances.keys.each do |name|
+        @container.register_instance(instances[name], name)
+      end
+
+      singletons = {
+        dandy_config: Config,
+        type_loader: TypeLoader,
+        dependency_loader: DependencyLoader,
+        template_loader: TemplateLoader,
+        template_registry: TemplateRegistry,
+        view_builder_registry: ViewBuilderRegistry,
+        view_factory: ViewFactory,
+        chain_factory: ChainFactory,
+        file_reader: Routing::FileReader,
+        syntax_parser: SyntaxParser,
+        syntax_error_interpreter: Routing::SyntaxErrorInterpreter,
+        routes_builder: Routing::Builder,
+        route_parser: Routing::Parser
+      }
+
+      singletons.keys.each do |name|
+        @container.register(singletons[name], name)
+          .using_lifetime(:singleton)
+      end
+    end
+
+    def load_basic_dependencies
+      @chain_factory = @container.resolve(:chain_factory)
+      @view_factory = @container.resolve(:view_factory)
+      @dependency_loader = @container.resolve(:dependency_loader)
+      @view_builder_registry = @container.resolve(:view_builder_registry)
+      @route_parser = @container.resolve(:route_parser)
+
+      @dependency_loader.load_components
+    end
+
+    def parse_routes
+      @routes = @route_parser.parse
+      @route_matcher = Routing::Matcher.new(@routes)
+    end
+  end
+end

data/lib/dandy/base/handle_errors.rb

@@ -0,0 +1,16 @@
+module Dandy
+  class HandleErrors
+    def initialize(container, dandy_error)
+      @container = container
+      @dandy_error = dandy_error
+    end
+
+    protected
+    def set_http_status(status_code)
+      @container
+        .register_instance(status_code, :dandy_status)
+        .using_lifetime(:scope)
+        .bound_to(:dandy_request)
+    end
+  end
+end

data/lib/dandy/chain.rb

@@ -0,0 +1,68 @@
+require 'timeout'
+
+module Dandy
+  class Chain
+    def initialize(container, dandy_config, commands, catch_command = nil)
+      @commands = commands
+      @container = container
+      @catch_command = catch_command
+      @async_timeout = dandy_config[:action][:async_timeout]
+    end
+
+    def execute
+      if @catch_command.nil?
+        run_commands
+      else
+        begin
+          run_commands
+        rescue Exception => error
+          @container
+            .register_instance(error, :dandy_error)
+            .using_lifetime(:scope)
+            .bound_to(:dandy_request)
+
+          action = @container.resolve(@catch_command.name.to_sym)
+          action.call
+        end
+      end
+    end
+
+    private
+
+    def run_commands
+      threads = []
+      Thread.abort_on_exception = true
+      @commands.each_with_index do |command, index|
+        if command.sequential?
+          # all previous parallel commands should be done before the current sequential
+          threads.each {|t| t.join}
+          threads = []
+
+          run_command(command)
+        else
+          thread = Thread.new {
+            Timeout::timeout(@async_timeout) {
+              run_command(command)
+            }
+          }
+          threads << thread if command.parallel?
+        end
+
+        # if it's last item in chain then wait until parallel commands are done
+        if index == @commands.length - 1
+          threads.each {|t| t.join}
+        end
+      end
+    end
+
+    def run_command(command)
+      action = @container.resolve(command.name.to_sym)
+      result = action.call
+
+      @container
+        .register_instance(result, command.result_name.to_sym)
+        .using_lifetime(:scope)
+        .bound_to(:dandy_request)
+    end
+  end
+end