harukizaemon-system_settings 2.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,46 @@
+== 2.0.1 released 2009-02-08
+
+* Bump version number to try and get it to build on GitHub.
+
+== 2.0.0 released 2009-01-14
+
+* Updated to Rails 2.2.2.
+* Removed all dependencies.
+
+== 2007-10-01
+
+* (#14286) Calls to SystemSetting[:environment] return nil.
+
+== 2006-10-13
+
+* install.rb informs user of missing dependencies.
+
+== 2006-09-09
+
+* Removed dependency on RedHill on Rails Core.
+* Removed dependency on defunct Schema Defining.
+
+== 2006-09-04
+
+* Migration script generated with a column limit for name to satisfy most databases. If you're using a database such as PostgreSQL--that supports unbounded text fields with no performance penalties--and wish to have the previous behaviour, you can still edit the generated file and change it manually.
+
+== 2006-09-03
+
+* Migration script generator determines pluralisation at generation time.
+
+== 2006-09-02
+
+* The default generated migration script name is now create_system_settings.rb
+* Correctly handle pluralisation of the table name via Inflector.
+
+== 2006-08-02
+
+* Removed validates_uniqueness_of :name. Install the schema_validations plugin instead.
+
+== 2006-07-17
+
+* Removed validates_presence_of :value. Install the schema_validations plugin instead.
+
+== 2006-07-03
+
+* Initial version.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Simon Harris
+
+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.rdoc

@@ -0,0 +1,45 @@
+= System Settings
+
+System Settings is a plugin that provides a convenient way to store and retrieve system configuration settings in the
+database. The plugin provides a single model SystemSetting with two properties name+, and value+ Names must be unique
+whereas values have no such restriction.
+
+To create and retrieve system settings, the usual active record operations can be used:
+
+  SystemSetting.create(:name => "environment", :value => "production")
+  SystemSetting.find_by_name("environment")   # => "production"
+  SystemSetting[:environment]                 # => "production"
+
+Note that you can lookup a system setting using either a string or a symbol.
+
+== Installation
+
+You have two choices for installation. The first uses a gem (recommended):
+
+  config.gem "harukizaemon-system_settings", :lib => "system_settings", :source => "http://gems.github.com"
+
+Or you can use the Rails plugin
+
+  $ ruby script/plugin install git://github.com/harukizaemon/system_settings.git
+
+Once installed, System Settings requires the creation of a single table. You may choose to perform this step manually,
+or use the generator provided. To use the generator, run:
+
+  ./script/generate system_settings_migration
+
+This will generate an appropriately numbered migration script named <code>NNN_create_system_settings.rb</code> in the
+<code>db/migrate</code> directory. The next time you run rake migrate, the table will automatically be created for you.
+
+If you would prefer a different name for the script, simply pass the name as an argument. For example:
+
+  ./script/generate system_settings_migration create_the_system_settings_table
+  
+The plugin fully supports and understands the following active-record configuration properties:
+
+* config.active_record.pluralize_table_names
+* config.active_record.table_name_prefix
+* config.active_record.table_name_suffix
+
+=== License
+
+This plugin is copyright 2009 by Simon Harris and is released under the MIT license.

data/generators/system_settings_migration/system_settings_migration_generator.rb

@@ -0,0 +1,12 @@
+class SystemSettingsMigrationGenerator < Rails::Generator::NamedBase
+  def initialize(runtime_args, runtime_options = {})
+    runtime_args << 'create_system_settings' if runtime_args.empty?
+    super
+  end
+
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate'
+    end
+  end
+end

data/generators/system_settings_migration/templates/migration.rb

@@ -0,0 +1,18 @@
+<%
+  table_name = "system_setting"
+  table_name = table_name.pluralize if ActiveRecord::Base.pluralize_table_names
+-%>
+class <%= class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+      t.column :name,   :string,  :null => false, :limit => 255
+      t.column :value,  :text,    :null => false
+    end
+
+    add_index :<%= table_name %>, [:name], :unique => true
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/lib/system_setting.rb

@@ -0,0 +1,27 @@
+class SystemSetting < ActiveRecord::Base
+  unless defined?(RedHillConsulting::SchemaValidations)
+    validates_presence_of :name
+    validates_uniqueness_of :name
+    validates_length_of :name, :maximum => 255
+  end
+
+  def self.find_by_name(name)
+    first(:conditions => ["name = ?", name.to_s]) unless name.nil?
+  end
+
+  def self.[](name)
+    find_by_name(name)
+  end
+
+  def to_f
+    value.to_f
+  end
+
+  def to_i
+    value.to_i
+  end
+
+  def to_s
+    value
+  end
+end

data/system_settings.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name     = "system_settings"
+  s.version  = "2.0.1"
+  s.date     = "2009-01-14"
+  s.summary  = "Store and retrieve Ruby on Rails application configuration settings in the database."
+  s.email    = "haruki.zaemon@gmail.com"
+  s.homepage = "http://github.com/harukizaemon/system_settings"
+  s.description = "Store and retrieve Ruby on Rails application configuration settings in the database."
+  s.has_rdoc = true
+  s.authors  = ["Simon Harris"]
+  s.files    = ["CHANGELOG.rdoc",
+                "MIT-LICENSE",
+                "README.rdoc",
+                "system_settings.gemspec",
+                "generators/system_settings_migration",
+                "generators/system_settings_migration/system_settings_migration_generator.rb",
+                "generators/system_settings_migration/templates",
+                "generators/system_settings_migration/templates/migration.rb",
+                "lib/system_setting.rb"]
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "README.rdoc"]
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: harukizaemon-system_settings
+version: !ruby/object:Gem::Version 
+  version: 2.0.1
+platform: ruby
+authors: 
+- Simon Harris
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-14 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Store and retrieve Ruby on Rails application configuration settings in the database.
+email: haruki.zaemon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.rdoc
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- MIT-LICENSE
+- README.rdoc
+- system_settings.gemspec
+- generators/system_settings_migration
+- generators/system_settings_migration/system_settings_migration_generator.rb
+- generators/system_settings_migration/templates
+- generators/system_settings_migration/templates/migration.rb
+- lib/system_setting.rb
+has_rdoc: true
+homepage: http://github.com/harukizaemon/system_settings
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Store and retrieve Ruby on Rails application configuration settings in the database.
+test_files: []
+