volt 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 151e9fd7b7262c2b6ae7dc51fe4974ffb1c65628
-  data.tar.gz: d43d340ea71cb98295ec0d3c5682676254b23ad5
+  metadata.gz: 3901f1ded564b432e705d7e1a024c3928c78d47a
+  data.tar.gz: 28af2588df6aefc650102f363e24f1ec92a28359
 SHA512:
-  metadata.gz: ffbae1aa4a8653a2a9a7b36ef302aa32cbf81fe1f4aeb1d8f86e471d22bb27083cf1c018d3d5e6f89aa520f72e1f89a4b0ae21391701d6f1916726b909cbc3e8
-  data.tar.gz: b6eefeb6b8fc07eabcc9f65ad6c0d28d577ff54409c8a16afdfdc13ef48b0f2b4296cd4c3c8c1734abe875f366c543fdcd1f1491454fdba45efd6020684e72cb
+  metadata.gz: 0259a07ecc92434d0c840c58323326ff7d0af81816c43dc3d13b7fced08656bdfd012231d2e88d6b4df01996dedf7529725a18e11d1fa4faacac2772dcdf4aa7
+  data.tar.gz: 6fe287443de67207d5e91a9e5739479454ff12750f6ae5b86533a36cfe899a6893dddffb09a9a2150326072a3377448b11970e587ba8cc43224d786a4c2cb961

data/Readme.md

@@ -99,6 +99,7 @@ You can access the Volt console with:
 10. [Testing](#testing)
 11. [Volt Helpers](#volt-helpers)
   1. [Logging](#logging)
+  2. [App Configuration](#app-configuration)
 
 # Getting Help
 
@@ -480,15 +481,18 @@ To convert a Model or an ArrayModel back to a normal hash, call .to_h or .to_a r
     user = Model.new
     user._name = 'Ryan'
     user._profiles = {
-      twitter: 'http://www.twitter.com/ryanstout',
-      dribbble: 'http://dribbble.com/ryanstout'
+      _twitter: 'http://www.twitter.com/ryanstout',
+      _dribbble: 'http://dribbble.com/ryanstout'
     }
 
     user._profiles.to_h
-    # => {twitter: 'http://www.twitter.com/ryanstout', dribbble: 'http://dribbble.com/ryanstout'}
+    # => {_twitter: 'http://www.twitter.com/ryanstout', _dribbble: 'http://dribbble.com/ryanstout'}
 
     items = ArrayModel.new([1,2,3,4])
-    items
+    # => #<ArrayModel:70226521081980 [1, 2, 3, 4]>
+
+    items.to_a
+    # => [1,2,3,4]
 ```
 
 You can get a normal array again by calling .to_a on an ArrayModel.
@@ -834,6 +838,22 @@ You can change the logger with:
 Volt.logger = Logger.new
 ```
 
+## App Configuration
+
+Like many frameworks, Volt changes some default settings based on an environment flag.  You can set the volt environment with the VOLT_ENV environment variable.
+
+All files in the app's ```config``` folder are loaded when Volt boots.  This is similar to the ```initializers``` folder in Rails.
+
+Volt does its best to start with useful defaults.  You can configure things like your database and app name in the config/app.rb file.  The following are the current configuration options:
+
+| name      | default                   | description                                                   |
+|-----------|---------------------------|---------------------------------------------------------------|
+| app_name  | the current folder name   | This is used internally for things like logging.              |
+| db_driver | 'mongo'                   | Currently mongo is the only supported driver, more coming soon|
+| db_name   | "#{app_name}_#{Volt.env}  | The name of the mongo database.                               |
+| db_host   | 'localhost'               | The hostname for the mongo database.                          |
+| db_port   | 27017                     | The port for the mongo database.                              |
+| compress_deflate | false              | If true, will run deflate in the app server, its better to let something like nginx do this though |
 
 ## Accessing DOM section in a controller
 

data/VERSION

@@ -1 +1 @@
-0.8.2
+0.8.3

data/app/volt/tasks/live_query/data_store.rb

@@ -2,8 +2,7 @@ require 'mongo'
 
 class DataStore
   def initialize
-    @@mongo_db ||= Mongo::MongoClient.new("localhost", 27017)
-    @@db ||= @@mongo_db.db("development")
+    @@db = Volt::DataStore.fetch
   end
 
   def query(collection, query)

data/app/volt/tasks/store_tasks.rb

@@ -3,8 +3,7 @@ require 'query_tasks'
 
 class StoreTasks
   def initialize(channel=nil, dispatcher=nil)
-    @@mongo_db ||= Mongo::MongoClient.new("localhost", 27017)
-    @@db ||= @@mongo_db.db("development")
+    @@db = Volt::DataStore.fetch
 
     @channel = channel
     @dispatcher = dispatcher

data/lib/volt.rb

@@ -2,6 +2,11 @@ require 'volt/volt/environment'
 require 'volt/extra_core/extra_core'
 require 'volt/reactive/computation'
 require 'volt/reactive/dependency'
+if RUBY_PLATFORM == 'opal'
+else
+  require 'volt/config'
+  require 'volt/data_stores/data_store'
+end
 
 class Volt
   if RUBY_PLATFORM == 'opal'
@@ -45,4 +50,5 @@ class Volt
   def self.in_browser?
     @@in_browser
   end
+
 end

data/lib/volt/boot.rb

@@ -8,6 +8,9 @@ end
 
 class Volt
   def self.boot(app_path)
+    # Run the app config to load all users config files
+    Volt.run_files_in_config_folder
+
     component_paths = ComponentPaths.new(app_path)
     component_paths.require_in_components
 

data/lib/volt/config.rb

@@ -0,0 +1,31 @@
+# Config lets a user set global config options for Volt.
+class Volt
+
+  def self.setup
+    yield self.config
+  end
+
+  def self.config
+    @config || self.reset_config!
+  end
+
+  # Resets the configuration to the default (empty hash)
+  def self.reset_config!
+    app_name = File.basename(Dir.pwd)
+
+    @config = OpenStruct.new({
+      app_name: app_name,
+      db_name: ENV['DB_NAME'] || (app_name + '_' + Volt.env.to_s),
+      db_host: ENV['DB_HOST'] || 'localhost',
+      db_port: (ENV['DB_PORT'] || 27017).to_i,
+      db_driver: ENV['DB_DRIVER'] || 'mongo'
+    })
+  end
+
+  # Load in all .rb files in the config folder
+  def self.run_files_in_config_folder
+    Dir[Dir.pwd + '/config/*.rb'].each do |config_file|
+      require(config_file)
+    end
+  end
+end

data/lib/volt/data_stores/data_store.rb

@@ -0,0 +1,13 @@
+require 'volt/data_stores/mongo_driver'
+
+class Volt
+  class DataStore
+    def self.fetch
+      if Volt.config.db_driver == 'mongo'
+        return MongoDriver.fetch
+      else
+        raise "#{database_name} is not a supported database"
+      end
+    end
+  end
+end

data/lib/volt/data_stores/mongo_driver.rb

@@ -0,0 +1,14 @@
+require 'mongo'
+
+class Volt
+  class DataStore
+    class MongoDriver
+      def self.fetch
+        @@mongo_db ||= Mongo::MongoClient.new(Volt.config.db_host, Volt.config.db_path)
+        @@db ||= @@mongo_db.db(Volt.config.db_name)
+
+        return @@db
+      end
+    end
+  end
+end

data/lib/volt/server.rb

@@ -80,9 +80,11 @@ class Server
     @app = Rack::Builder.new
 
     # Should only be used in production
-    # @app.use Rack::Deflater
+    if Volt.config.deflate
+      @app.use Rack::Deflater
+      @app.use Rack::Chunked
+    end
 
-    # @app.use Rack::Chunked
     @app.use Rack::ContentLength
 
     @app.use Rack::KeepAlive

data/lib/volt/volt/environment.rb

@@ -34,5 +34,9 @@ class Volt
     def inspect
       @env.inspect
     end
+
+    def to_s
+      @env
+    end
   end
 end

data/templates/project/app/main/views/main/{main.html → main.html.tt}

@@ -8,7 +8,7 @@
         <:nav href="/" text="Home" />
         <:nav href="/about" text="About" />
       </ul>
-      <h3 class="text-muted">Project name</h3>
+      <h3 class="text-muted"><%= config[:name].titleize %></h3>
     </div>
 
     <:volt:notices />

data/templates/project/config/app.rb.tt

@@ -0,0 +1,20 @@
+Volt.setup do |config|
+  # Setup your global app config here.
+
+  # The app name defaults to the folder it is run in.
+  # config.app_name = '<%= config[:name] %>'
+
+  # Database config all start with db_ and can be set either in the config
+  # file or with an environment variable (DB_NAME for example).
+
+  # config.db_driver = 'mongo'
+  # config.db_name = (config.app_name + '_' + Volt.env.to_s)
+  # config.db_host = 'localhost'
+  # config.db_port = 27017
+
+  # Compression options
+
+  # If you are not running behind something like nginx in production, you can
+  # have rack deflate all files.
+  # config.deflate = true
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: volt
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Ryan Stout
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-03 00:00:00.000000000 Z
+date: 2014-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -377,8 +377,11 @@ files:
 - lib/volt/cli.rb
 - lib/volt/cli/asset_compile.rb
 - lib/volt/cli/new_gem.rb
+- lib/volt/config.rb
 - lib/volt/console.rb
 - lib/volt/controllers/model_controller.rb
+- lib/volt/data_stores/data_store.rb
+- lib/volt/data_stores/mongo_driver.rb
 - lib/volt/extra_core/array.rb
 - lib/volt/extra_core/blank.rb
 - lib/volt/extra_core/extra_core.rb
@@ -566,8 +569,9 @@ files:
 - templates/project/app/main/models/.empty_directory
 - templates/project/app/main/views/main/about.html
 - templates/project/app/main/views/main/index.html
-- templates/project/app/main/views/main/main.html
+- templates/project/app/main/views/main/main.html.tt
 - templates/project/config.ru
+- templates/project/config/app.rb.tt
 - templates/project/lib/.empty_directory
 - templates/project/public/index.html
 - templates/project/spec/sample_spec.rb