flok 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6dd5854740ffca215345f553e605128fe4c96eaf
-  data.tar.gz: b8d705a36091be26a782332e85951e81d8cdb6b5
+  metadata.gz: c5e1200a43eac75a5bdf221ec8653eeaec723f88
+  data.tar.gz: b8b102d8edd66ef040de7ec101a6e30b33be5833
 SHA512:
-  metadata.gz: b212db2926d45f322bbd5398f98507bc36a65bd13e9ca5572a2852e7b1fd206058cfb46a5103a2a6e4e81bc10cd107231ed6bbf86fdc2b6bc9fc1bb6051eccc3
-  data.tar.gz: 6dc1bd4f98989edca5e3a4555213456e3cb901b2668c82c406d6005b9fbf5cc54da2ff707d461d8b75944539271e7883fa963639284484ce6374bba61b5b3256
+  metadata.gz: 9139c10262284a1b2358f2b3863c803d739f818b68cdfbbc58830f6368fb086cfd5703ce09823242186f734023b7a443760ec93be490b5117d057bf068532cab
+  data.tar.gz: 34febd5c86fd6bb185f007da137fc4ae648ea98e56ee366c82a8cf16ddd23bbb23539f7e47421cd708fa743f2d3b4d7c415ec775cd1bcb07c479cc7aa4c32b52

data/README.md

@@ -1,4 +1,4 @@
-![flok: The mobile application framework](https://raw.githubusercontent.com/sotownsend/flok/master/logo.png)
+![flok: The eventful application framework](https://raw.githubusercontent.com/sotownsend/flok/master/logo.png)
 
 [![Gem Version](https://badge.fury.io/rb/iarrogant.svg)](http://badge.fury.io/rb/flok)
 [![Build Status](https://travis-ci.org/sotownsend/flok.svg)](https://travis-ci.org/sotownsend/flok)
@@ -9,6 +9,24 @@
 
 A work in progress
 
+# Flok Modules
+A concept borrowed from [Rails engines](http://guides.rubyonrails.org/engines.html), Flok modules both serve as your project files, all library modules, and gemified instances.  That is, a project you create is automatically modular and can be imported in another flok module/project.
+
+# Compilation
+Flok does not rely on ruby for the final produced `application.js` file.  The output file is pure javascript and written in javascript (not transcoded).  Ruby only serves as a compilation assistant.
+
+# Task
+The task is the base unit in flok, similar to a rack module except that rack is a stack and flok is a party.  Based on concepts borrowed from XNU®, FreeBSD®, and GNU HURD®; tasks are combined in flok to produce behavior by many tasks inter-cooperating.  Efficiency has been provided through virtualizing the task communication so that no message passing takes place inside flok and all modules are combined into an efficient monolithic module.
+
+### Task Facilities
+Tasks are able to
+ - send and receive events from a global or internal source.
+ - set interval and timeout timers.
+ - store temporary data in it's own heap '$__'
+
+### Default modules
+This flok project contains the 'micro-task-kernel', the 'ui', and the 'operations' modules.
+
 ## Requirements
 
 - Mac OS X 10.9+ (Untested)

data/bin/flok

@@ -2,11 +2,29 @@
 
 require 'flok'
 require 'thor'
+require 'fileutils'
 
 class FlokCLI < Thor
   desc "new <path>", "Create a new flok project and/or module, you may supply an absolute path or relative, the last entry in the path will be the module name and folder name of the project"
   def new path
-    Dir.mkdir path
+    name = File.basename(path)
+    Dir.chdir File.dirname(path) do
+      `bundle gem #{name}`
+
+      Dir.chdir name do
+        Dir.mkdir "app"
+        Dir.mkdir "config"
+      end
+    end
+  end
+
+  desc "build", "Build a flok project, you must be in the root of the project"
+  def build
+    Dir.mkdir("./public") unless File.exists?("./public")
+    FileUtils.touch "./public/application.js"
+
+    kernel_src = Flok::MergeSource.merge_kernel
+    File.write("./public/application.js", kernel_src)
   end
 end
 

data/flok.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.3"
   spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "execjs", "~> 2.4.0"
   spec.add_runtime_dependency "thor", "~> 0.19"
   spec.executables << 'flok'
 end

data/lib/flok.rb

@@ -1,5 +1,21 @@
 require "flok/version"
 
 module Flok
-  # Your code goes here...
+  module MergeSource
+    #Merge all the kernel javascript files into one string
+    def self.merge_kernel
+      Dir.chdir(File.dirname(__FILE__)) do
+        Dir.chdir("./js/kernel/") do
+          js_files = Dir["*.js"]
+          out = ""
+          js_files.each do |js|
+            out << File.read(js)
+            out << "\n"
+          end
+
+          return out
+        end
+      end
+    end
+  end
 end

data/lib/flok/version.rb

@@ -1,3 +1,3 @@
 module Flok
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/js/kernel/common.js

@@ -0,0 +1 @@
+Kernel = {}

data/lib/js/kernel/handleCustomEvent.js

@@ -1,8 +1,8 @@
 //Forward all custom events to all tasks
-Rebar.handleCustomEvent = function(type, event) {
-  var len = Rebar.tasks.length;
+Kernel.handleCustomEvent = function(type, event) {
+  var len = Kernel.tasks.length;
   for (var i = 0; i < len; ++i) {
-    var task = Rebar.tasks[i]
+    var task = Kernel.tasks[i]
     task.handle(type, event)
   }
 }

data/lib/js/kernel/handleInitEvent.js

@@ -1,4 +1,4 @@
-Rebar.hasInit = false
-Rebar.handleInitEvent = function(event) {
-  Rebar.hasInit = true
+Kernel.hasInit = false
+Kernel.handleInitEvent = function(event) {
+  Kernel.hasInit = true
 }

data/lib/js/kernel/handleTickEvent.js

@@ -1,2 +1,2 @@
-Rebar.handleTickEvent = function(event){
+Kernel.handleTickEvent = function(event){
 }

data/lib/js/kernel/pipe.js

@@ -1,30 +1,30 @@
-Rebar.process = function(event) {
+Kernel.process = function(event) {
   var type = event.type;
   //All events need a type
-  if (type === undefined) { throw "Rebar got an event that had no type!"; }
+  if (type === undefined) { throw "Kernel got an event that had no type!"; }
 
-  if (Rebar.hasInit === false) {
+  if (Kernel.hasInit === false) {
     if (type === "init") {
-      Rebar.handleInitEvent(event);
+      Kernel.handleInitEvent(event);
     } else {
-      throw "Rebar got a first event that was not an init, it was " + type
+      throw "Kernel got a first event that was not an init, it was " + type
     }
   } else {
     //Is this a special event?
     if (type === "tick") {
-      Rebar.handleTickEvent(event);
+      Kernel.handleTickEvent(event);
     } else {
-      Rebar.handleCustomEvent(type, event);
+      Kernel.handleCustomEvent(type, event);
     }
   }
 
   //Return outbound event queue
-  var queue = Rebar.outboundEventQueue;
-  Rebar.outboundEventQueue = [];
+  var queue = Kernel.outboundEventQueue;
+  Kernel.outboundEventQueue = [];
   return queue;
 }
 
-Rebar.outboundEventQueue = [];
-Rebar.sendEvent = function(event) {
-  Rebar.outboundEventQueue.push(event);
+Kernel.outboundEventQueue = [];
+Kernel.sendEvent = function(event) {
+  Kernel.outboundEventQueue.push(event);
 }

data/lib/js/kernel/task.js

@@ -1,13 +1,13 @@
 //Global task list
-Rebar.tasks = [];
+Kernel.tasks = [];
 
-Rebar.Task = function(name) {
+Kernel.Task = function(name) {
   this.name = name;
-  Rebar.tasks.push(this);
+  Kernel.tasks.push(this);
 
   this.sendEvent = function(type, info) {
     info.type = type;
-    Rebar.sendEvent(info);
+    Kernel.sendEvent(info);
   }
 
   var handlers = [];

data/spec/cli_spec.rb

@@ -2,8 +2,34 @@ require './lib/flok.rb'
 require 'tempfile'
 require 'securerandom'
 
+def ensure_tmp
+  tmp_spec_path = './spec/tmp'
+  Dir.mkdir(tmp_spec_path) unless File.exists?(tmp_spec_path)
+end
+
 RSpec.describe "CLI" do
-  it "Creates a new module folder" do
+  it "Creates a new module folder with absolute path" do
+    #Get a temporary file, delete it, but save the path
+    temp = Tempfile.new "flok-temp"
+    path = temp.path
+    temp.close
+    temp.unlink
+
+    `ruby -Ilib ./bin/flok new #{path}`
+
+    expect(Dir.exists? path).to be(true)
+  end
+
+  it "Creates a new module folder with relative path" do
+    ensure_tmp
+    fn = SecureRandom.hex
+
+    dir = "./spec/tmp/#{fn}"
+    `ruby -Ilib ./bin/flok new #{dir}`
+    expect(File.exists?(dir)).to be(true)
+  end
+
+  it "Creates a new module folder with correct root folders" do
     #Get a temporary file, delete it, but save the path
     temp = Tempfile.new "flok-temp"
     path = temp.path
@@ -12,6 +38,112 @@ RSpec.describe "CLI" do
 
     `ruby -Ilib ./bin/flok new #{path}`
 
-    (Dir.exists? path).should eq(true)
+    folders = %w{app lib config}
+
+    folders.each do |f|
+      p = "#{path}/#{f}"
+      expect(Dir.exists? p).to be(true)
+    end
+  end
+
+  it "The new module has all the files and folders of a RubyGem" do
+    #Get a temporary file, delete it, but save the path
+    temp = Tempfile.new "flok-temp"
+    path = temp.path
+    temp.close
+    temp.unlink
+    Dir.mkdir(path)
+    test_gem_path = "#{path}/test_gem"
+    Dir.mkdir(test_gem_path)
+    file_paths = []
+    dir_paths = []
+    name = "#{SecureRandom.hex[0..4]}_module_name"
+    Dir.chdir(test_gem_path) do
+      `bundle gem #{name}`
+
+      Dir.chdir "./#{name}" do
+        Dir["**/*"].each do |f|
+          if File.file?(f)
+            file_paths << f
+          end
+
+          if File.directory?(f)
+            dir_paths << f
+          end
+        end
+      end
+
+      file_paths.uniq!
+      dir_paths.uniq!
+    end
+
+    `ruby -Ilib ./bin/flok new #{path}/#{name}`
+    Dir.chdir "#{path}/#{name}" do
+      Dir["**/*"].each do |f|
+        if File.file?(f)
+          file_paths = file_paths - [f]
+        end
+
+        if File.directory?(f)
+          dir_paths = dir_paths - [f]
+        end
+      end
+
+      if file_paths.count+dir_paths.count != 0
+        puts "------------------------------------------------------------------------------"
+        puts "Files not found matching Gemfile: #{file_paths.inspect}" if file_paths.count > 0
+        puts "Directories not found matching Gemfile: #{dir_paths.inspect}" if dir_paths.count > 0
+        puts "------------------------------------------------------------------------------"
+      end
+
+      expect(file_paths.count+dir_paths.count).to be(0)
+    end
+  end
+
+  it "does create a public/application.js when 'build' is run" do
+    #Get a temporary file, delete it, but save the path
+    temp = Tempfile.new "flok-temp"
+    path = temp.path
+    temp.close
+    temp.unlink
+
+    `ruby -Ilib ./bin/flok new #{path}`
+    gem_root_path = File.expand_path(File.dirname(__FILE__))+"/.."
+    Dir.chdir path do
+      `ruby -I#{gem_root_path}/lib #{gem_root_path}/bin/flok build`
+      expect(File.exist?("./public/application.js")).to be(true)
+    end
+  end
+
+  it "does create a public/application.js when 'build' is run that's not empty" do
+    #Get a temporary file, delete it, but save the path
+    temp = Tempfile.new "flok-temp"
+    path = temp.path
+    temp.close
+    temp.unlink
+
+    `ruby -Ilib ./bin/flok new #{path}`
+    gem_root_path = File.expand_path(File.dirname(__FILE__))+"/.."
+    Dir.chdir path do
+      `ruby -I#{gem_root_path}/lib #{gem_root_path}/bin/flok build`
+      expect(File.read("./public/application.js").length).to be > 0
+    end
+  end
+
+  it "creates an application.js that is executable by js" do
+    #Get a temporary file, delete it, but save the path
+    temp = Tempfile.new "flok-temp"
+    path = temp.path
+    temp.close
+    temp.unlink
+
+    `ruby -Ilib ./bin/flok new #{path}`
+    gem_root_path = File.expand_path(File.dirname(__FILE__))+"/.."
+    Dir.chdir path do
+      `ruby -I#{gem_root_path}/lib #{gem_root_path}/bin/flok build`
+      str = File.read("./public/application.js")
+      ExecJS.compile(str)
+#it does not throw an error
+    end
   end
 end

data/spec/merge_source_spec.rb

@@ -0,0 +1,27 @@
+require './lib/flok.rb'
+require 'tempfile'
+require 'securerandom'
+require 'execjs'
+
+def ensure_tmp
+  tmp_spec_path = './spec/tmp'
+  Dir.mkdir(tmp_spec_path) unless File.exists?(tmp_spec_path)
+end
+
+RSpec.describe "Flok::MergeSourceSpec" do
+  it "when merging the kernel, it returns a string" do
+    str = Flok::MergeSource.merge_kernel
+    expect(str.class).to be(String)
+  end
+
+  it "when merging the kernel, it returns a string with length" do
+    str = Flok::MergeSource.merge_kernel
+    expect(str.length).to be > 0
+  end
+
+  it "when merging the kernel, the kernel files located in ./lib/js/kernel/ do merge and run without js syntax errors" do
+    str = Flok::MergeSource.merge_kernel
+    ExecJS.compile(str)
+    #It does not throw an error
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flok
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - seo
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: execjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -71,7 +85,6 @@ description: Flok is a cross-platform application framework system that exports
 email:
 - seotownsend@icloud.com
 executables:
-- banner.png
 - flok
 extensions: []
 extra_rdoc_files: []
@@ -82,11 +95,11 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/banner.png
 - bin/flok
 - flok.gemspec
 - lib/flok.rb
 - lib/flok/version.rb
+- lib/js/kernel/common.js
 - lib/js/kernel/handleCustomEvent.js
 - lib/js/kernel/handleInitEvent.js
 - lib/js/kernel/handleTickEvent.js
@@ -94,6 +107,7 @@ files:
 - lib/js/kernel/task.js
 - logo.png
 - spec/cli_spec.rb
+- spec/merge_source_spec.rb
 homepage: https://github.com/sotownsend/flok
 licenses:
 - MIT
@@ -120,4 +134,5 @@ specification_version: 4
 summary: A boring javascript application framework
 test_files:
 - spec/cli_spec.rb
+- spec/merge_source_spec.rb
 has_rdoc: