informante 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8f97cb1b4499fe1d35af676b87e07d14010ba28
+  data.tar.gz: 6108c457932262b534b06197f542e6c6858fdde5
+SHA512:
+  metadata.gz: eb3b90c313d7c77eeefa0575b4c8a7506e196166048813f837770fc38f03141e57b9e5831be10b36465c08d615e336ba8e497362d158f3d936f75a8a204d8439
+  data.tar.gz: 3749c60bf413a622f4d73f7b9f7c773972fe0f33b328ead611ba65ea606002bd160adc1708f96feb1ea334f8f48c5101f4f79b38f1ad95a74612fec96940fbdd

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in informante.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 igortice
+
+MIT License
+
+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.md

@@ -0,0 +1,100 @@
+# Informante
+
+Simple rails gem for configurations of global inforamations
+
+This gem is to provide a simple way of storing information in one place and get this information anywhere in a Rails application.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'informante'
+```
+
+And then execute:
+
+```ruby
+bundle install
+```
+
+Finishing, use the generator provided by Informante:
+
+```ruby
+rails g informante:install
+```
+> This command is responsible for generating two files for our application:
+> * informante.yml - file with yaml markup to store information for our application
+> * informante.rb  - contains global method called `informante` for our application
+
+## Usage
+
+By default, our `informante.yml` file has the following configuration:
+
+```yaml
+# -- basic example for informante.yml --
+#
+system:
+  name          : 'Name System'
+  title         : 'Title System'
+  description   : 'Description System'
+  company       : '© Company System'
+  business      : 'Business System'
+  developers    : [
+    {
+      name  : 'name',
+      email : 'email',
+      site  : 'site'
+    },
+  ]
+```
+
+> you can store the configuration file that you want, simply follow the standard format for yaml and save the file `informante.yml`
+
+At every point of our application, just use the global method `informante`.
+See an example on the console:
+
+```sh
+$ informante[:system][:name]
+>> "Name System"
+```
+
+By default our informante method returns a hash with symbol key. This method responds to four types of format:
+
+```ruby
+- informante(:hash) # informante(:hash) == informant
+- informante(:object)
+- informante(:array)
+- informante(:string)
+```
+Example for respond to object:
+
+```sh
+$ informante(:object).system.description
+>> "Description System"
+```
+
+Example for respond to string:
+
+```sh
+$ informante(:string)
+>> "{:system=>{:name=>\"Name System\", :title=>\"Title System\", :description=>\"Description System\", :company=>\"© Company System\", :business=>\"Business System\", :developers=>[{:name=>\"name\", :email=>\"email\", :site=>\"site\"}]}}"
+```
+
+
+## Notes
+
+You can use the `informante` method directly:
+
+* **controllers**
+* **views**
+* **models**
+* **helpers**
+
+Important, every time you **modify** the `informante.yml` file you must **restart** the **rails server**.
+
+
+## Version
+
+0.0.1

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/informante.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'informante/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "informante"
+  spec.version       = Informante::VERSION
+  spec.authors       = ["igortice"]
+  spec.email         = ["igortice@gmail.com"]
+  spec.summary       = %q{Simple gem rails for configurations of global inforamations}
+  spec.description   = %q{This gem is to provide a simple way of storing information in one place and get this information anywhere in a Rails application.}
+  spec.homepage      = "https://github.com/igortice/informante"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/generators/informante/install_generator.rb

@@ -0,0 +1,17 @@
+require 'informante/templates'
+
+module Informante::Generators
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../templates", __FILE__)
+
+    def copy_config_file
+      file_name = Informante::NAME_TEMPLATE_CONIG
+      copy_file(file_name, "config/#{file_name}")
+    end
+
+    def copy_initializer_file
+      file_name = Informante::NAME_TEMPLATE_INITIALIZERS
+      copy_file(file_name, "config/initializers/#{file_name}")
+    end
+  end
+end

data/lib/generators/templates/informante.rb

@@ -0,0 +1,7 @@
+# -- informante method global --
+# specify type attributes, for example: :hash, :object, :array, :string.
+# Default: `:hash`
+#
+def informante(type = :hash)
+  Informante.set(type)
+end

data/lib/generators/templates/informante.yml

@@ -0,0 +1,46 @@
+#  -- serveral examples for yml --
+#
+#  invoice: 34843
+#  date   : 2001-01-23
+#  bill_to: &id001
+#    given  : Chris
+#    family : Dumars
+#    address:
+#      lines: |
+#        458 Walkman Dr.
+#        Suite #292
+#      city    : Royal Oak
+#      state   : MI
+#      postal  : 48046
+#  ship_to: *id001
+#  product:
+#    - sku         : BL394D
+#      quantity    : 4
+#      description : Basketball
+#      price       : 450.00
+#    - sku         : BL4438H
+#      quantity    : 1
+#      description : Super Hoop
+#      price       : 2392.00
+#  tax  : 251.42
+#  total: 4443.52
+#  comments: >
+#    Late afternoon is best.
+#    Backup contact is Nancy
+#    Billsmer @ 338-4338.
+
+# -- basic example for informante.yml --
+#
+system:
+  name          : 'Name System'
+  title         : 'Title System'
+  description   : 'Description System'
+  company       : '© Company System'
+  business      : 'Business System'
+  developers    : [
+    {
+      name  : 'name',
+      email : 'email',
+      site  : 'site'
+    },
+  ]

data/lib/informante.rb

@@ -0,0 +1,62 @@
+require 'informante/templates'
+require 'informante/informante_object'
+require 'informante/hash'
+
+module Informante
+  extend self
+
+  def set(type = nil)
+    return nil unless type
+
+    config(type)
+  end
+
+  def config(type = :hash)
+    case type
+      when :hash
+        to_hash
+      when :object
+        to_object
+      when :array
+        to_array
+      when :string
+        to_string
+      else
+        raise "type `:#{type}` invalid for informante"
+    end
+  end
+
+  def to_hash
+    file_informante_to_yaml.recursive_symbolize_keys!
+  end
+
+  def to_array
+    to_hash.to_a
+  end
+
+  def to_string
+    to_hash.to_s
+  end
+
+  def to_object
+    InformanteObject.new to_hash
+  end
+
+  def path_file_informante_config
+    Rails.root.join('config', Informante::NAME_TEMPLATE_CONIG)
+  end
+
+  def file_informante
+    File.exist?(path_file_informante_config) ? File.read(path_file_informante_config) : nil
+  end
+
+  def file_informante_to_yaml
+    if self.file_informante
+      begin
+        YAML.load(file_informante)
+      rescue => e
+        raise "problem sintaxe file #{Informante::NAME_TEMPLATE_CONIG} #{e.to_s}"
+      end
+    end
+  end
+end

data/lib/informante/hash.rb

@@ -0,0 +1,10 @@
+class Hash
+  def recursive_symbolize_keys!
+    symbolize_keys!
+    # symbolize each hash in .values
+    values.each { |h| h.recursive_symbolize_keys! if h.is_a?(Hash) }
+    # symbolize each hash inside an array in .values
+    values.select { |v| v.is_a?(Array) }.flatten.each { |h| h.recursive_symbolize_keys! if h.is_a?(Hash) }
+    self
+  end
+end

data/lib/informante/informante_object.rb

@@ -0,0 +1,15 @@
+class InformanteObject < OpenStruct
+  def initialize(hash=nil)
+    @table = {}
+    @hash_table = {}
+
+    if hash
+      hash.each do |k,v|
+        @table[k.to_sym] = (v.is_a?(Hash) ? self.class.new(v) : v)
+        @hash_table[k.to_sym] = v
+
+        new_ostruct_member(k)
+      end
+    end
+  end
+end

data/lib/informante/templates.rb

@@ -0,0 +1,4 @@
+module Informante
+  NAME_TEMPLATE_CONIG        = 'informante.yml'
+  NAME_TEMPLATE_INITIALIZERS = 'informante.rb'
+end

data/lib/informante/version.rb

@@ -0,0 +1,3 @@
+module Informante
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: informante
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- igortice
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is to provide a simple way of storing information in one place
+  and get this information anywhere in a Rails application.
+email:
+- igortice@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- informante.gemspec
+- lib/generators/informante/install_generator.rb
+- lib/generators/templates/informante.rb
+- lib/generators/templates/informante.yml
+- lib/informante.rb
+- lib/informante/hash.rb
+- lib/informante/informante_object.rb
+- lib/informante/templates.rb
+- lib/informante/version.rb
+homepage: https://github.com/igortice/informante
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Simple gem rails for configurations of global inforamations
+test_files: []