configural 0.0.1

data/lib/configural/platform.rb

@@ -0,0 +1,130 @@
+#--
+#
+# This file is one part of:
+#
+# Configural - Easy configuration file management
+#
+# Copyright (c) 2011  John Croisant
+#
+# 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.
+#
+#++
+
+require 'rbconfig'
+
+module Configural
+
+  class Platform
+    def self.inherited(subclass)
+      @subclasses ||= []
+      @subclasses << subclass
+    end
+
+    def self.get_platform( app )
+      platform = @subclasses.reverse.find { |subclass|
+        subclass.match?( app )
+      }
+      unless platform
+        raise 'Sorry, your operating system is not yet supported.'
+      end
+      platform
+    end
+
+    def self.match?( app )
+      raise 'Method not implemented for base class.'
+    end
+
+
+    def initialize( app )
+      @app = app
+    end
+
+    def cache_path
+      raise 'Method not implemented for base class.'
+    end
+
+    def config_path
+      raise 'Method not implemented for base class.'
+    end
+
+    def data_path
+      raise 'Method not implemented for base class.'
+    end
+  end
+
+
+  class LinuxPlatform < Platform
+    def self.match?( app )
+      true if /linux/ =~ RbConfig::CONFIG['host_os']
+    end
+
+    def cache_path
+      File.join( ENV['HOME'], '.cache', @app.name )
+    end
+
+    def config_path
+      File.join( ENV['HOME'], '.config', @app.name )
+    end
+
+    def data_path
+      File.join( ENV['HOME'], '.local', 'share', @app.name )
+    end
+  end
+
+
+  class MacPlatform < Platform
+    def self.match?( app )
+      true if /darwin/ =~ RbConfig::CONFIG['host_os']
+    end
+
+    def cache_path
+      File.join( ENV['HOME'], 'Library', 'Caches', @app.name )
+    end
+
+    def config_path
+      File.join( ENV['HOME'], 'Library', 'Preferences', @app.name )
+    end
+
+    def data_path
+      File.join( ENV['HOME'], 'Library',
+                 'Application Support', @app.name )
+    end
+  end
+
+
+  class WindowsPlatform < Platform
+    def self.match?( app )
+      true if /mswin|mingw/ =~ RbConfig::CONFIG['host_os']
+    end
+
+    def cache_path
+      File.join( ENV['APPDATA'], @app.name, 'Cache' )
+    end
+
+    def config_path
+      File.join( ENV['APPDATA'], @app.name, 'Config' )
+    end
+
+    def data_path
+      File.join( ENV['APPDATA'], @app.name, 'Data' )
+    end
+  end
+
+end

data/lib/configural/user.rb

@@ -0,0 +1,71 @@
+#--
+#
+# This file is one part of:
+#
+# Configural - Easy configuration file management
+#
+# Copyright (c) 2011  John Croisant
+#
+# 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.
+#
+#++
+
+
+module Configural
+
+  class User
+    attr_accessor :platform
+
+    def initialize( app )
+      @app = app
+      @platform = Configural::Platform.get_platform(app).new(app)
+    end
+
+    def config
+      @config ||= Configural::Config.new(self)
+    end
+
+    def config_path
+      @platform.config_path
+    end
+
+    def cache
+      @cache ||= Configural::Cache.new(self)
+    end
+
+    def cache_path
+      @platform.cache_path
+    end
+
+    def data
+      @data ||= Configural::Data.new(self)
+    end
+
+    def data_path
+      @platform.data_path
+    end
+
+    def save_all
+      @config.save_all if @config
+      self
+    end
+  end
+
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: configural
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- John Croisant
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-30 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: john@croisant.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- NEWS.rdoc
+- README.rdoc
+- lib/configural/app.rb
+- lib/configural/autosave.rb
+- lib/configural/config/file_base.rb
+- lib/configural/config/json_file.rb
+- lib/configural/config/plist_file.rb
+- lib/configural/config/sdl_file.rb
+- lib/configural/config/yaml_file.rb
+- lib/configural/config.rb
+- lib/configural/data.rb
+- lib/configural/platform.rb
+- lib/configural/user.rb
+- lib/configural.rb
+- ChangeLog.txt
+homepage: http://github.com/jacius/configural/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.8'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Easy configuration file management
+test_files: []