fron 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee70da4161fdf883ebd912c124c53c5a8bb8ada5
+  data.tar.gz: ab1e9096d251fc25a772e8b9fcf9798b1b8deda4
+SHA512:
+  metadata.gz: cdddc4a004ae3e9160e82fa001db6f41199038d72e47426a4953ce40dbf2f681c0ba2dacd4f9fd31e66a8140c372590fadbe6004a0049b4f5ad1fd51b3592698
+  data.tar.gz: d265e541022bfb84a9299c6b9ca24386738ba932f5679cfe37fe5b3bd959734aa2bf20f39ec3930cb101619a61d36dc754c84fa77a40daf5bea375b932fa3d07

data/docs/application.md

@@ -0,0 +1,7 @@
+# Application
+
+* [Configuration]()
+* [Controllers]()
+* [Routers]()
+* [Components]()
+* [DOM]()

data/docs/configuration.md

@@ -0,0 +1,29 @@
+# Configuration
+Application configuration utility.
+
+## Title
+The layout of the application can be set with the 'title' DSL.
+
+## Layout
+The layout of the application can be set with the 'layout' DSL.
+
+This DSL takes a block and runs it in the context of the main application component, with the injection poin for controllers as the argument.
+
+## Routes
+For using routes see the [routing documentation]().
+
+## Example
+```ruby
+class TestApplication < Application
+	config.title = 'Test Application'
+
+	config.layout do |main|
+		component :header, 'header'
+		self << main
+	end
+
+	config.routes do
+		map SiteController
+	end
+end
+```

data/docs/controllers.md

@@ -0,0 +1,35 @@
+# Controllers
+Controllers are responsible for parts of the application, it handles state / view changes for itself only.
+
+## Base Component
+The base component can be specified with the `base` DSL method.
+
+The base component is the "page" wthich is injected into the document when a route matches this controller. It is accessible with the `@base` attribute. It must be a subclass of `Component`.
+
+## Global Events
+A controller can listen on Global Events with the `on` DSL.
+
+The first argument is the event to listen to and the second argument is the method to run when the event triggered. Globa Events can be trigger like so:
+```ruby
+Eventable.trigger 'load'
+```
+
+## Routes
+For using routes see the [routing documentation]().
+
+## Example
+```ruby
+class TestController < Controller
+  base BaseComponent
+
+  on :load, :loaded
+
+  def loaded
+
+  end
+
+  def test
+    puts @base
+  end
+end
+```

data/docs/routing.md

@@ -0,0 +1,63 @@
+# Routing
+There are two leves of routing:
+
+* Application level: This defines which controller is responsibe for specified paths
+* Controller level: This defines which actions / sub controllers on the controller are called for specified paths
+
+## Applications Routes
+Routes are defined in the Application Configuration with the `routes` DSL method.
+
+You can define controllers for specific paths, for example the following `map 'users/', UserController` will delegate all paths under the `users/` to the `UserController`. The controller only recieves the portion of the path which remains after the matched path.
+
+## Controller Routes
+Routes are defined with the `route` DSL method.
+
+The first argument is the path, the second argument is the action / sub controller to be called. The path can contain parameter identifiers such as `:name`. These will be passed along to the action as a hash in the first parameter.
+
+## Before Filters
+Before filters can be added to the controllers actions with the `beforeFilter` DSL method.
+
+The first argument is the action to be called, the second argument is an array of methods which before the action should be called.
+
+## Example
+```ruby
+class TestApplication < Application
+  config.routes do
+    # Both 'users/new' and 'users/10' will be
+    # handled by an instance of UserController
+    map 'users/', UserController
+
+    # Anything else will be handled by
+    # an instance of IndexController
+    map IndexController
+  end
+end
+
+class CommentsController < Controller
+  ...
+end
+
+class UserController < Controller
+  # users/new -> UserController#authorize -> UserController#new
+  route 'new', :new
+  # users/10/comments -> CommentsController with params[:id] = 10
+  route ':id/comments/', CommentsController
+  # users/10  -> UserController#authorize -> USerController#user with params[:id] = 10
+  route ':id', :user
+
+  beforeFilter :authorize, [:new,:user]
+
+  def new
+    ...
+  end
+
+  def user(params)
+    puts params[:id]
+    ...
+  end
+
+  def authorize
+    ...
+  end
+end
+```

data/fron.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/fron/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name         = 'fron'
+  s.version      = Fron::VERSION
+  s.author       = 'Gusztav Szikszai'
+  s.email        = 'gusztav.szikszai@digitalnatives.hu'
+  s.homepage     = ''
+  s.summary      = 'Frontend Application Framework'
+  s.description  = 'Frontend Application Framework that uses Opal'
+
+  s.files          = `git ls-files`.split("\n")
+  s.executables    = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.test_files     = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths  = ['lib']
+
+  s.add_runtime_dependency 'opal', ['~> 0.6.2']
+  s.add_development_dependency 'opal-rspec', '~> 0.3.0.beta3'
+end

data/lib/fron.rb

@@ -0,0 +1,4 @@
+require 'opal'
+require 'fron/version'
+
+Opal.append_path File.expand_path('../../opal', __FILE__).untaint

data/lib/fron/version.rb

@@ -0,0 +1,3 @@
+module Fron
+	VERSION = '0.1.0'
+end

data/opal/fron.rb

@@ -0,0 +1,5 @@
+require 'opal'
+require './fron/dom'
+require './fron/request'
+require './fron/storage'
+require './fron/core'

data/opal/fron/core-ext/hash.rb

@@ -0,0 +1,17 @@
+class Hash
+  def to_query_string
+    r = []
+    each do |key,value|
+      r << `encodeURIComponent(#{key})+"="+encodeURIComponent(#{value})`
+    end
+    r.join "&"
+  end
+
+  def to_form_data
+    r = `new FormData()`
+    each do |key,value|
+      `r.append(#{key},#{value})`
+    end
+    r
+  end
+end

data/opal/fron/core.rb

@@ -0,0 +1,10 @@
+require './core/logger'
+require './core/component'
+require './core/adapters/rails'
+require './core/adapters/local-storage'
+require './core/configuration'
+require './core/eventable'
+require './core/model'
+require './core/router'
+require './core/controller'
+require './core/application'

data/opal/fron/core/adapters/local-storage.rb

@@ -0,0 +1,41 @@
+require 'json'
+require 'securerandom'
+
+module Fron
+  module Adapters
+    class LocalAdapter
+      def initialize(options)
+        @options = options
+      end
+
+      def all(&block)
+        block.call LocalStorage.all
+      end
+
+      def get(id, &block)
+        block.call LocalStorage.get id
+      end
+
+      def set(id, data, &block)
+        id = SecureRandom.uuid unless id
+        data[:id] = id
+        unless (errors = validate data)
+          LocalStorage.set id, data
+          block.call nil
+        else
+          block.call errors
+        end
+      end
+
+      def validate(data)
+        errors = {}
+        @options[:fields].map do |field|
+          next unless data[field] == ""
+          errors[field] = ["can't be blank"]
+          valid = false
+        end
+        errors.keys.length == 0 ? nil : errors
+      end
+    end
+  end
+end

data/opal/fron/core/adapters/rails.rb

@@ -0,0 +1,48 @@
+module Fron
+  module Adapters
+    class RailsAdapter
+
+      def initialize(options)
+        @options = options
+        @request = Request.new
+      end
+
+      def all(&block)
+        setUrl nil
+        @request.get { |response| block.call response.json }
+      end
+
+      def get(id,&block)
+        setUrl id
+        @request.get { |response| block.call response.json }
+      end
+
+      def set(id,data,&block)
+        setUrl id
+        method = id ? 'put' : 'post'
+        @request.send(method,transform(data)) do |response|
+          block.call case response.status
+          when 201, 204
+            nil
+          when 422
+            response.json
+          end
+        end
+      end
+
+      private
+
+      def setUrl(id)
+        base = @options[:endpoint] + "/" + @options[:resources]
+        base += id ? "/" + id.to_s : ".json"
+        @request.url = base
+      end
+
+      def transform(data)
+        newdata = data.dup
+        newdata.keys.each{ |key| newdata["#{@options[:resource]}[#{key}]"] = newdata.delete key}
+        newdata
+      end
+    end
+  end
+end

data/opal/fron/core/application.rb

@@ -0,0 +1,39 @@
+module Fron
+  class Application
+    class << self
+      def config
+        @configuration ||= Configuration.new
+      end
+    end
+
+    def initialize
+      @routeMap = []
+      DOM::Document.title = config.title
+      instance_eval &config.routeBlock
+      @router = Router.new @routeMap, config
+
+      DOM::Window.on 'load' do
+        config.stylesheets.map do |sheet|
+          link = DOM::Element.new("link[rel=stylesheet][type=text/css][href=#{sheet}]")
+          link.on 'load' do
+            config.logger.info "External stylesheet loaded: #{sheet}"
+          end
+          DOM::Document.head << link
+        end
+      end
+      config.logger.info "Initialized Applicationation!"
+      config.logger.info "Inserting application to DOM!"
+      DOM::Document.body << config.app
+    end
+
+    private
+
+    def map(*args)
+      @routeMap << Router.map(*args)
+    end
+
+    def config
+      self.class.config
+    end
+  end
+end

data/opal/fron/core/component.rb

@@ -0,0 +1,81 @@
+module Fron
+  class Component < DOM::Element
+    attr_reader :model
+
+    class << self
+      attr_accessor :events
+      attr_accessor :tagname
+      attr_accessor :components
+
+      def tag(tag)
+        @tagname = tag
+      end
+
+      def on(*args)
+        @events ||= []
+        @events << args
+      end
+
+      def component(*args,&block)
+        attr_reader args[0]
+        @components ||= []
+        @components << ( args << block )
+      end
+
+      def delegate(method,target)
+        define_method(method) do
+          instance_variable_get("@#{target}").send(method)
+        end
+
+        define_method(method+"=") do |value|
+          instance_variable_get("@#{target}").send(method+"=",value)
+        end
+      end
+    end
+
+    def initialize(*args)
+      case args.length
+      when 1
+        @model = args[0]
+      when 2
+        tag, @model = args
+      end
+
+      super tag || self.class.tagname || self.class.name.split("::").last
+
+      applyEvents
+      createComponents
+
+      return if !respond_to?(:render) || !@model
+      @model.on 'change' do render end
+      render
+    end
+
+    def component(name,comp,&block)
+      c = comp.is_a?(Class) ? comp.new(@model) : Component.new(comp, @model)
+      c.instance_eval(&block) if block
+      self << c
+      self.instance_variable_set "@#{name}", c
+    end
+
+    private
+
+    def createComponents
+      return unless self.class.components
+      self.class.components.each do |args|
+        component args[0], args[1], &args[2]
+      end
+    end
+
+    def applyEvents
+      return unless self.class.events
+      self.class.events.each do |args|
+        if args.length == 3
+          delegate(args[0], args[1]) { |e| self.method(args[2]).call e }
+        else
+          on(args[0]) { |e| self.method(args[1]).call e }
+        end
+      end
+    end
+  end
+end

data/opal/fron/core/configuration.rb

@@ -0,0 +1,26 @@
+module Fron
+  class Configuration
+    class App < Component
+    end
+    class Yield < Component
+    end
+
+    attr_accessor :title, :stylesheets, :logger
+    attr_reader :routeBlock, :main, :app
+
+    def initialize
+      @main = Yield.new
+      @app = App.new
+
+      DOM::Document.body.empty
+    end
+
+    def routes(&block)
+      @routeBlock = block
+    end
+
+    def layout(&block)
+      @app.instance_exec @main, &block
+    end
+  end
+end