configurable_engine 0.0.1 → 0.1.0

data/README.md

@@ -1,6 +1,6 @@
 # Configurable #
 
-A Rails 3 configuration plugin. An update to [Behavior](http://github.com/paulca/behavior).
+A Rails 3 configuration engine. An update to [Behavior](http://github.com/paulca/behavior) for Rails 3.
 
 ## How it works ##
 
@@ -12,31 +12,31 @@ If you or your app users need to change these variables, Configurable stores new
 
 Configurable is available as a Ruby gem. Simply add it to your Rails 3 app's `Gemfile`:
 
-    gem 'configurable'
+    gem 'configurable_engine'
 
 Then run the `configurable_engine:install` generator:
 
-    rails generate configurable:install
+    rails generate configurable_engine:install
 
 ## Usage ##
 
-There are two parts to how behavior works. First of all there is a config file, config/behavior.yml. This file controls the variables that are allowed to be set in the app.
+There are two parts to how behavior works. First of all there is a config file, config/configurable.yml. This file controls the variables that are allowed to be set in the app.
 
-For example, if you wanted to have access to a config variable "site_title", put this in behavior.yml:
+For example, if you wanted to have access to a config variable "site_title", put this in configurable.yml:
 
-  site_title:
-    name: Site Title
-    default: My Site
+    site_title:
+      name: Site Title
+      default: My Site
   
-Now, within your app, you can access `Configurable[:site\_title]` (or `Configurable.site_title` if you prefer).
+Now, within your app, you can access `Configurable[:site_title]` (or `Configurable.site_title` if you prefer).
 
-If you want to update the config, create a Configurable record in the database:
+Since Configurable is an ActiveRecord model, if you want to update the config, create a Configurable record in the database:
 
     Configurable.create!(:name => 'site_title', :value => 'My New Site')
     
 ## Web Interface ##
 
-Using Rails 3's Engines feature, Configurable comes with a web interface that is available to your app straight away at `http://localhost:3000/admin/configurable`.
+Configurable comes with a web interface that is available to your app straight away at `http://localhost:3000/admin/configurable`.
 
 If you want to add a layout, or protect the configurable controller, create `app/controllers/admin/application_controller.rb` which would look something like this:
 
@@ -83,7 +83,11 @@ Within the `dummy` folder, run:
     bundle exec rspec spec
     bundle exec cucumber features
 
-== Copyright
+## Contributing ##
+
+All contributions are welcome. Just fork the code, ensure your changes include a test, ensure all the current tests pass and send a pull request.
+
+## Copyright ##
 
 Copyright (c) 2011 Paul Campbell. See LICENSE.txt for
 further details.

data/Rakefile

@@ -22,7 +22,7 @@ Jeweler::Tasks.new do |gem|
   # Include your dependencies below. Runtime dependencies are required when using your gem,
   # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
   gem.add_runtime_dependency 'rails', '~>3.0.0'
-  gem.files = FileList["[A-Za-z]*", "app/**/*", "config/*"]
+  gem.files = FileList["[A-Za-z]*", "lib/**/*", "app/**/*", "config/*"]
   #  gem.add_development_dependency 'rspec', '> 1.2.3'
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/configurable_engine.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{configurable_engine}
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul Campbell"]
@@ -28,7 +28,11 @@ Gem::Specification.new do |s|
     "app/models/configurable.rb",
     "app/views/admin/configurables/show.html.erb",
     "config/routes.rb",
-    "configurable_engine.gemspec"
+    "configurable_engine.gemspec",
+    "lib/configurable_engine.rb",
+    "lib/generators/configurable_engine/install_generator.rb",
+    "lib/generators/configurable_engine/templates/configurable.yml",
+    "lib/generators/configurable_engine/templates/migration.rb"
   ]
   s.homepage = %q{http://github.com/paulca/configurable_engine}
   s.licenses = ["MIT"]

data/lib/configurable_engine.rb

@@ -0,0 +1,4 @@
+module ConfigurableEngine
+  class Engine < Rails::Engine
+  end
+end

data/lib/generators/configurable_engine/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+module Configurable
+class InstallGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+
+   def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+   end
+ 
+   def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+ 
+    def create_migration_file
+      copy_file 'configurable.yml', 'config/configurable.yml'
+      migration_template 'migration.rb', 'db/migrate/create_configurables.rb'
+    end
+  end
+end

data/lib/generators/configurable_engine/templates/configurable.yml

@@ -0,0 +1,33 @@
+# This file controls what config variables you want to be able to allow your users
+# to set, as well as those you'll be able to access from within the application.
+# 
+# If you want to be able to access a string config[:site_title], for example:
+#   
+# site_title:
+#   name: Site Title
+#   type: string
+#   default: My Site
+#   
+# 'name' is the name that appears in the edit form
+# 
+# 'type' can be 'string' for a text field, 'password' for a password field or 'text' for a text area
+#   'type' defaults to 'string'
+# 
+# 'default' is the default value to use if there's no entry in the database. Otherwise, nil will be returned
+# 
+# Some Examples:
+#   
+# site_title:
+#   name: Site Title
+#   default: My Site
+#   type: string
+#   
+# site_description:
+#   name: Description for Google
+#   default: Lots of Awesomeness Here
+#   type: text
+#   
+# secret:
+#   name: Secret Password for Accessing Secret Areas
+#   default: secret
+#   type: password

data/lib/generators/configurable_engine/templates/migration.rb

@@ -0,0 +1,17 @@
+class CreateConfigurables < ActiveRecord::Migration
+  def self.up
+    create_table :configurables do |t|
+      t.string :name
+      t.string :value
+
+      t.timestamps
+    end
+    
+    add_index :configurables, :name
+  end
+
+  def self.down
+    remove_index :configurables, :name
+    drop_table :configurables
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Paul Campbell
@@ -106,6 +106,10 @@ files:
 - app/views/admin/configurables/show.html.erb
 - config/routes.rb
 - configurable_engine.gemspec
+- lib/configurable_engine.rb
+- lib/generators/configurable_engine/install_generator.rb
+- lib/generators/configurable_engine/templates/configurable.yml
+- lib/generators/configurable_engine/templates/migration.rb
 has_rdoc: true
 homepage: http://github.com/paulca/configurable_engine
 licenses: 
@@ -120,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -271690143338276698
+      hash: 2354103642827299759
       segments: 
       - 0
       version: "0"