user_space 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 964e9a54183227b621f7fa093cc644b25eb59055
+  data.tar.gz: 81ad79c904d9bdfba3c3c604223bba5da8ab323b
+SHA512:
+  metadata.gz: 0af919b9206d6a386dc68ce5a3a180e7afaa3991dde99a2fca2c545ee868488eb8f232c614cb4a364690d6cc9fc53615b4e3e51141828f2bda0c0eb24f301c8b
+  data.tar.gz: 28d1d0a93e1368808cb3c03c5bc486e02356bde12d83a70a683d089289d7765e78975343daf6643c5546434deb97a3b1d68d366033b688c2b4a9d50d29c76822

data/History.txt

@@ -0,0 +1 @@
+=== 0.0.0 / 2013-12-21 09:33:10 -0800

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+README.rdoc
+TODO.txt
+data/VERSION
+features/main.feature
+features/step_definitions/main_steps.rb
+lib/user_space.rb
+lib/user_space/user_space.rb
+lib/user_space/version.rb
+test/user_space.rb
+user_space.gemspec

data/README.rdoc

@@ -0,0 +1,59 @@
+= user_space
+
+== DESCRIPTION:
+
+Automates certain XDG features.
+
+== SYNOPSIS:
+
+   require 'user_space'
+   # APP::CONFIG is your app's configuration.
+   # Perhaps like...
+   APP::CONFIG = {:tts=>'espeak', }
+   # By default, UserSpace works with the JSON parser.
+   USERSPACE = USER_SPACE::UserSpace.new
+   # Unless this version has been installed,
+   # we copy over our data and cache directories.
+   USERSPACE.install unless USERSPACE.version == APP::VERSION
+   if USERSPACE.config?
+     # Because JSON hashes by String, converting to Symbol.
+     # We pad up APP::CONFIG with user's preferences:
+     USERSPACE.config.each{|opt, value| APP::CONFIG[opt.to_sym] = value}
+   else
+     # We initialize user preferences with our initial APP::CONFIG
+     STDERR.puts "Writting '#{USERSPACE.config_file_name}'"
+     USERSPACE.config = APP::CONFIG
+   end
+
+== FEATURES/PROBLEMS:
+
+* Still in alpha, have not publish to ruby gems yet.
+
+== INSTALL:
+
+Not yet available.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2013 CarlosJHR64
+
+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/TODO.txt

@@ -0,0 +1,5 @@
+== File List
+
+TODO:	Come up with some good cucumber tests.
+	features/step_definitions/main_steps.rb, #2
+

data/data/VERSION

@@ -0,0 +1 @@
+1.20.300

data/features/main.feature

@@ -0,0 +1,9 @@
+@main
+Feature: Main Feature
+
+  Background:
+    * Given main feature
+
+  Scenario:
+    * When main feature
+    * Then main feature

data/features/step_definitions/main_steps.rb

@@ -0,0 +1,18 @@
+require 'rainbow'
+# TODO: Come up with some good cucumber tests.
+Given /^(\w+) (.*)$/ do |given, condition|
+  condition.strip!
+  case given
+  when 'Given'
+    #raise "'Given' form not defined."
+    STDERR.puts "Need to come up with some cucumber tests".color(:blue)
+  when 'When'
+    #raise "'When' form not defined."
+    STDERR.puts "Need to come up with some cucumber tests".color(:blue)
+  when 'Then'
+    #raise "'Then' form not defined."
+    STDERR.puts "Need to come up with some cucumber tests".color(:blue)
+  else
+    raise "'#{given}' form not defined."
+  end
+end

data/lib/user_space.rb

@@ -0,0 +1,8 @@
+require 'English'
+require 'fileutils'
+require 'json' # default parser
+require 'xdg'
+require 'user_space/version.rb'
+require 'user_space/user_space.rb'
+# Requires:
+#`ruby`

data/lib/user_space/user_space.rb

@@ -0,0 +1,105 @@
+module USER_SPACE
+  class UserSpace
+
+    OPTIONS    = {:config  => 'config',
+                  :parser  =>  JSON,
+                  :ext     =>  nil,
+                  :version => 'VERSION'}
+
+    PARAMETERS = {:appname  => File.basename($PROGRAM_NAME),
+                  :appdir   => nil, # Can't guess at this point yet?
+                  :xdgbases => ['CACHE', 'CONFIG', 'DATA']}
+
+    attr_reader :appname, :appdir, :xdgbases, :options
+    def initialize(parameters=PARAMETERS)
+
+      @appname  = parameters[:appname]  || PARAMETERS[:appname]
+      @appdir   = parameters[:appdir]   || PARAMETERS[:appdir]
+      @xdgbases = parameters[:xdgbases] || PARAMETERS[:xdgbases]
+      @options  = OPTIONS
+
+      unless @appdir
+        appdir = File.dirname File.dirname caller.first.split(/:/,2).first
+        @appdir = File.expand_path appdir
+      end
+
+      # install with no overwrite
+      install(false)
+    end
+
+    def xdg_pairs
+      @xdgbases.each do |base|
+        xdg = XDG[base].to_s
+        userdir = File.join(xdg, @appname)
+        basedir = File.join @appdir, base.downcase
+        yield basedir, userdir
+      end
+    end
+
+    # Note that initialize will not overwrite anything.
+    # This overwrites the user's data directory with a fresh install.
+    # App should consider being nice about this,
+    # like warn the user or something.
+    def install(overwrite=true)
+      xdg_pairs do |basedir, userdir|
+        if File.exist?(userdir)
+          # Sanity check
+          raise "Not a directory: #{userdir}" unless File.directory?(userdir)
+          # Pre-existing directory.
+          # Return unless user wants to overwrite.
+          return unless overwrite
+        else
+          Dir.mkdir(userdir, 0700)
+        end
+        FileUtils.cp_r(Dir.glob("#{basedir}/*"), userdir) if File.directory? basedir
+      end
+    end
+
+    def cachedir
+      File.join XDG['CACHE'].to_s, @appname
+    end
+
+    def configdir
+      File.join XDG['CONFIG'].to_s, @appname
+    end
+
+    def datadir
+      File.join XDG['DATA'].to_s, @appname
+    end
+
+    # Not really for public use.
+    def config_file_name(options=@options)
+      parser   = options[:parser]
+      ext      = options[:ext] || parser.to_s.downcase
+      basename = "#{options[:config]}.#{ext}"
+      File.join XDG['CONFIG'].to_s, @appname, basename
+    end
+
+    # Not really for public use.
+    def version_file_name
+      File.join XDG['DATA'].to_s, @appname, @options[:version]
+    end
+
+    def config?(options=@options)
+      File.exist?(config_file_name(options))
+    end
+
+    # Reads config
+    def config(options=@options)
+      options[:parser].parse File.read(config_file_name(options))
+    end
+
+    # Saves config
+    def config=(obj, options=@options)
+      File.open(config_file_name, 'w', 0600){|fh| fh.puts options[:parser].pretty_generate obj}
+    end
+
+    # This reads the data directory's version file
+    def version
+      fn = version_file_name
+      return nil unless File.exist? fn
+      File.read(version_file_name).strip
+    end
+
+  end
+end

data/lib/user_space/version.rb

@@ -0,0 +1,3 @@
+module USER_SPACE
+  VERSION = '0.0.0'
+end

data/test/user_space.rb

@@ -0,0 +1,93 @@
+require 'test/unit'
+require 'tmpdir'
+TMPDIR      = Dir.mktmpdir
+Dir.mkdir File.join TMPDIR, '.cache'
+Dir.mkdir File.join TMPDIR, '.config'
+Dir.mkdir File.join TMPDIR, '.local'
+Dir.mkdir File.join TMPDIR, '.local', 'share'
+APPNAME     = 'ima2awesome'
+
+ENV['HOME'] = TMPDIR
+$0          = APPNAME
+
+# Needed to setup the enviroment first, now...
+require 'user_space'
+
+class TestUserSpace < Test::Unit::TestCase
+
+  include USER_SPACE
+
+  def test_user_space_version
+    assert_equal('0.0.0', VERSION)
+  end
+
+  def test_user_space_constants
+    assert_equal 'config',  UserSpace::OPTIONS[:config]
+    assert_equal JSON,      UserSpace::OPTIONS[:parser]
+    assert_equal 'VERSION', UserSpace::OPTIONS[:version]
+    assert_nil   UserSpace::OPTIONS[:ext]
+
+    assert_equal 'ima2awesome', UserSpace::PARAMETERS[:appname]
+
+    xdgbases = UserSpace::PARAMETERS[:xdgbases]
+    assert xdgbases.include? 'CACHE'
+    assert xdgbases.include? 'CONFIG'
+    assert xdgbases.include? 'DATA'
+  end
+
+  def test_user_space_new
+    userspace = nil
+    assert_nothing_raised(Exception){userspace = UserSpace.new}
+
+    assert_equal(APPNAME, userspace.appname)
+
+    dirname = File.dirname File.dirname File.expand_path __FILE__
+    assert_equal(dirname, userspace.appdir)
+
+    xdgbases = userspace.xdgbases
+    assert(userspace.xdgbases.include?('CACHE'))
+    assert(userspace.xdgbases.include?('CONFIG'))
+    assert(userspace.xdgbases.include?('DATA'))
+
+    count = 0
+    userspace.xdg_pairs do |basedir, userdir|
+      count += 1
+      assert(File.directory?(userdir))
+      refute_nil(userdir=~/\/ima2awesome$/)
+      refute_nil(basedir=~/user_space\/((data)|(config)|(cache))$/)
+    end
+    assert_equal(3, count)
+
+    options = userspace.options
+    assert_equal('config',  options[:config])
+    assert_equal('VERSION', options[:version])
+    assert_equal(JSON,      options[:parser])
+    assert_nil(options[:ext])
+
+    assert File.exist? userspace.cachedir
+    assert File.exist? userspace.configdir
+    assert File.exist? userspace.datadir
+
+    version = File.read('data/VERSION').strip
+    assert_equal version, userspace.version
+
+    refute File.exist? userspace.config_file_name
+    config1 = {'a'=>"A", 'b'=>"B"}
+    userspace.config = config1
+    assert File.exist? userspace.config_file_name
+    config2 = JSON.parse File.read userspace.config_file_name
+    assert_equal config1, config2
+
+    # Overwrite version file...
+    File.open(userspace.version_file_name, 'w'){|fh|fh.puts 'A.B.C'}
+    # Now we get the version given to the file:
+    assert_equal 'A.B.C', userspace.version
+    # Which is different from the initial version
+    refute version == 'A.B.C'
+
+    # But we can re-fresh our install
+    assert_nothing_raised(Exception){userspace.install}
+    # Now we have our initial version back
+    assert_equal version, userspace.version
+  end
+end

data/user_space.gemspec

@@ -0,0 +1,46 @@
+Gem::Specification.new do |s|
+
+  s.name     = 'user_space'
+  s.version  = '0.0.0'
+
+  s.homepage = 'https://github.com/carlosjhr64/user_space'
+
+  s.author   = 'CarlosJHR64'
+  s.email    = 'carlosjhr64@gmail.com'
+
+  s.date     = '2013-12-22'
+  s.licenses = ['MIT']
+
+  s.description = <<DESCRIPTION
+Automates certain XDG features.
+DESCRIPTION
+
+  s.summary = <<SUMMARY
+Automates certain XDG features.
+SUMMARY
+
+  s.extra_rdoc_files = ['README.rdoc']
+  s.rdoc_options     = ["--main", "README.rdoc"]
+
+  s.require_paths = ["lib"]
+  s.files = %w(
+History.txt
+Manifest.txt
+README.rdoc
+TODO.txt
+data/VERSION
+features/main.feature
+features/step_definitions/main_steps.rb
+lib/user_space.rb
+lib/user_space/user_space.rb
+lib/user_space/version.rb
+test/user_space.rb
+user_space.gemspec
+  )
+
+  s.add_runtime_dependency 'xdg', '~> 2.2', '>= 2.2.3'
+  s.add_development_dependency 'rainbow', '~> 1.1', '>= 1.1.4'
+  s.add_development_dependency 'test-unit', '~> 2.5', '>= 2.5.5'
+  s.requirements << 'ruby: ruby 2.0.0p247 (2013-06-27 revision 41674) [x86_64-linux]'
+
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: user_space
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- CarlosJHR64
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xdg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.5
+description: |
+  Automates certain XDG features.
+email: carlosjhr64@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- History.txt
+- Manifest.txt
+- README.rdoc
+- TODO.txt
+- data/VERSION
+- features/main.feature
+- features/step_definitions/main_steps.rb
+- lib/user_space.rb
+- lib/user_space/user_space.rb
+- lib/user_space/version.rb
+- test/user_space.rb
+- user_space.gemspec
+homepage: https://github.com/carlosjhr64/user_space
+licenses:
+- MIT
+metadata: {}
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- 'ruby: ruby 2.0.0p247 (2013-06-27 revision 41674) [x86_64-linux]'
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Automates certain XDG features.
+test_files: []