active_text 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm ree-1.8.7-2011.03@active_text

data/Gemfile

@@ -6,8 +6,9 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", ">= 2.3.0"
+  gem "rspec", "2.3.0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
   gem "rcov", ">= 0"
+  gem "autotest"
 end

data/Gemfile.lock

@@ -1,6 +1,9 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    ZenTest (4.5.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
     diff-lcs (1.1.2)
     git (1.2.5)
     jeweler (1.5.2)
@@ -22,7 +25,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  autotest
   bundler (~> 1.0.0)
   jeweler (~> 1.5.2)
   rcov
-  rspec (>= 2.3.0)
+  rspec (= 2.3.0)

data/README.textile

@@ -4,9 +4,69 @@ ActiveText is to text, as ActiveRecord is to the database. ActiveText is able to
 
 h2. Why would you want to do this?
 
-Ramon Tayag was looking for a way to edit SASS files in terms of variables. He wanted end-users who didn't know anything about SASS to be able to edit variables to change colors, images, etc, in the stylesheet. To acheive that, he needed the ability to parse through text files and easy replace variables in them.
+Ramon Tayag was looking for a way to edit SASS files in terms of variables. He wanted end-users who didn't know anything about SASS to be able to edit variables to change colors, images, etc, in the stylesheet. To achieve that, he needed the ability to parse through text files and easy replace variables in them.
 
-== Contributing to active_text
+h2. How does it work?
+
+Given this text:
+
+<pre>// @name Background image
+// @kind file
+// @description Background image. Tiled left to right, up to down, so the file has to be repeatable.
+$bg_image: "http://someurl.com/bg.jpg"
+
+// @name Link Color
+// @kind color
+// @description Color of the link text
+$link_color: #555;
+</pre>
+
+You can pass that into a ActiveText:
+
+<pre>
+@at = ActiveText::Base.new(text_you_see_above)
+@at.bg_image.name # returns "Background image"
+@at.bg_image.kind # returns "file"
+@at.bg_image.value # returns %Q("http://someurl.com/bg.jpg") - note that there are double quotes in the string
+@at.link_color.kind # returns "color"
+@at.link_color.value # returns "#555"
+</pre>
+
+You can also update the values:
+
+<pre>
+@at = ActiveText::Base.new(text_you_see_above)
+@at.bg_image.value = "'/path/to/image.png'"
+@at.render # returns the text passed into base, with values replaced:
+</pre>
+
+<pre>
+// @name Background image
+// @kind file
+// @description Background image. Tiled left to right, up to down, so the file has to be repeatable.
+$bg_image: '/path/to/image.png'
+
+// @name Link Color
+// @kind color
+// @description Color of the link text
+$link_color: #555;
+</pre>
+
+You can also mass update: <pre>@at.update_attributes(:bg_image => %Q("http://anotherurl.com/img.jpg"), :link_color => "green")</pre>
+
+h2. Gotchas
+
+Right now, only the following metadata will work:
+
+* name
+* kind
+* color
+
+And only the following format to pickup values for variables will work:
+
+<code>$variable_name: this is the value;</code>
+
+h2. Contributing to active_text
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -16,7 +76,6 @@ Ramon Tayag was looking for a way to edit SASS files in terms of variables. He w
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+h2. Copyright
 
-Copyright (c) 2011 Ramon Tayag. See LICENSE.txt for
-further details.
+Copyright (c) 2011 Ramon Tayag. See LICENSE.txt for further details.

data/Rakefile

@@ -8,15 +8,15 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'rake'
-
 require 'jeweler'
+
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "active_text"
-  gem.homepage = "http://github.com/ramon.tayag/active_text"
+  gem.homepage = "http://github.com/ramontayag/active_text"
   gem.license = "MIT"
-  gem.summary = %Q{ActiveText : Text as ActiveRecord : Database. Sort of.}
-  gem.description = %Q{ActiveText aims to be able to read and replace "variables" in text files. This won't be exactly feel like ActiveRecord, but similar where it seems it should.}
+  gem.summary = %Q{ActiveText : Text as ActiveRecord : Records. Sort of.}
+  gem.description = %Q{Aims to be able to read and replace "variables" in text in an active record manner. I don't claim that it behaves exactly like ActiveRecord - that is a much more complex beast than this will ever be.}
   gem.email = "ramon@tayag.net"
   gem.authors = ["Ramon Tayag"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,
@@ -26,28 +26,25 @@ Jeweler::Tasks.new do |gem|
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
 end
 
-task :default => :test
+task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "active_text #{version}"
+  rdoc.title = "at #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/active_text.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{active_text}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ramon Tayag"]
   s.date = %q{2011-03-18}
-  s.description = %q{ActiveText aims to be able to read and replace "variables" in text files. This won't be exactly feel like ActiveRecord, but similar where it seems it should.}
+  s.description = %q{Aims to be able to read and replace "variables" in text in an active record manner. I don't claim that it behaves exactly like ActiveRecord - that is a much more complex beast than this will ever be.}
   s.email = %q{ramon@tayag.net}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -18,6 +18,8 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".rspec",
+    ".rvmrc",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -25,33 +27,44 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "active_text.gemspec",
-    "lib/active_text.rb"
+    "lib/active_text.rb",
+    "lib/active_text/base.rb",
+    "lib/active_text/variable.rb",
+    "spec/active_text_spec.rb",
+    "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/ramon.tayag/active_text}
+  s.homepage = %q{http://github.com/ramontayag/active_text}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.6.2}
-  s.summary = %q{ActiveText : Text as ActiveRecord : Database. Sort of.}
+  s.summary = %q{ActiveText : Text as ActiveRecord : Records. Sort of.}
+  s.test_files = [
+    "spec/active_text_spec.rb",
+    "spec/spec_helper.rb"
+  ]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 2.3.0"])
+      s.add_development_dependency(%q<rspec>, ["= 2.3.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<autotest>, [">= 0"])
     else
-      s.add_dependency(%q<rspec>, [">= 2.3.0"])
+      s.add_dependency(%q<rspec>, ["= 2.3.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<autotest>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 2.3.0"])
+    s.add_dependency(%q<rspec>, ["= 2.3.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
     s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<autotest>, [">= 0"])
   end
 end
 

data/lib/active_text/base.rb

@@ -0,0 +1,60 @@
+module ActiveText
+  class Base
+    attr_reader :text, :variables
+    attr_writer :options
+
+    def initialize(text, options={})
+      @text = text
+      @variables = {}
+
+      options[:eol] ||= '\n'
+      options[:context_lines] ||= 3
+      options[:comment] ||= /\/\//
+      options[:context] ||= "(^(?:#{options[:comment]}\s@.*#{options[:eol]}){#{options[:context_lines]}})"
+      @options = options
+    end
+
+    def update_attributes(args)
+      args.each do |k, v|
+        send(k) # Instantiate it, so it will exist in @variables
+        @variables[k].value = v unless @variables[k].nil? || v.nil?
+      end
+    end
+
+    # Used to update the text
+    def render
+      @variables.each do |key, var|
+        @text.gsub!(/^\$#{key}: .+;/, %Q($#{key}: #{var.value};))
+      end
+      @text
+    end
+
+    protected
+
+    # Whenever a variable is requested for, it falls into this.
+    def method_missing(method_name)
+      if method_name.to_s =~ /[\w]+/
+        context = context_of(method_name)
+
+        # If there's no context (no variable with the proper
+        # commented metadata), then it should not be accessible
+        # and it won't be accessible
+        if context.nil? || context == ""
+          nil
+        else
+          @variables[method_name] ||= ActiveText::Variable.new(method_name, context, @options[:comment])
+        end
+      end
+    end
+
+    # Works this way: http://rubular.com/r/jWSYvfVrjj
+    # From http://rubular.com/r/jWSYvfVrjj
+    # Derived from http://stackoverflow.com/questions/2760759/ruby-equivalent-to-grep-c-5-to-get-context-of-lines-around-the-match
+    def context_of(s)
+      regexp = /.*\${1}#{s}:.*;[#{@options[:eol]}]*/
+      @text =~ /^#{@options[:context]}(#{regexp})/
+      before, match = $1, $2
+      "#{before}#{match}"
+    end
+  end
+end

data/lib/active_text/variable.rb

@@ -0,0 +1,49 @@
+module ActiveText
+  # These are currently the kinds of metadata that we can fetch
+  # This should be configurable in the future (or remove it entirely)
+  METADATA = %w(name kind description)
+
+  class Variable
+    attr_reader :key, :context, :comment
+
+    def initialize(key, context, comment)
+      # What the short name of this variable is
+      @key = key
+
+      # Text surrounding the variable, as determined by Base
+      @context = context
+
+      # What is considered a comment
+      @comment = comment
+    end
+
+    # if any of the metadata string methods are called
+    # then we return what the value is
+    def method_missing(method_name)
+      if METADATA.include? method_name.to_s
+        content_of(method_name.to_s)
+      end
+    end
+
+    def value
+      @context.each do |string|
+        string =~ /^\${1}#{@key}: (.+);/
+        return $1 if $1
+      end
+    end
+
+    def value=(val)
+      @context.gsub!(/^\$#{@key}: .+;/, "$#{@key}: #{val};")
+    end
+
+    private
+
+    def content_of(metadata)
+      @context.each do |string|
+        string =~ /^#{@comment} @([\w]+[^\s]) (.+)/
+        return $2 if $1 == metadata
+      end
+    end
+
+  end
+end

data/lib/active_text.rb

@@ -0,0 +1,2 @@
+require 'active_text/base'
+require 'active_text/variable'

data/spec/active_text_spec.rb

@@ -0,0 +1,96 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ActiveText" do
+  describe "given properly formatted input" do
+    before do
+      @text = %{// @name Masthead Background Image
+// @kind file
+// @description Background image.
+$mbc2: "http://someurl.com/image.jpg";
+
+// @name Masthead BG Color
+// @kind color
+// @description Background color.
+$mbc: #555;}
+    end
+
+    it "should be able to set variables and return them properly" do
+      @atb = ActiveText::Base.new(@text)
+
+      @atb.mbc.name.should == "Masthead BG Color"
+      @atb.mbc.kind.should == "color"
+      @atb.mbc.description.should == "Background color."
+      @atb.mbc.value.should == "#555"
+
+      @atb.mbc2.name.should == "Masthead Background Image"
+      @atb.mbc2.kind.should == "file"
+      @atb.mbc2.description.should == "Background image."
+      @atb.mbc2.value.should == %Q("http://someurl.com/image.jpg")
+    end
+  end
+
+  describe "when assigning values" do
+    it "should update its values" do
+      text = %{// @name Masthead Background Image
+// @kind file
+// @description Background image.
+$mbc2: "http://someurl.com/image.jpg";}
+      @s = ActiveText::Base.new(text)
+      @s.mbc2.value = %Q("Another URL")
+      @s.mbc2.value.should == %Q("Another URL")
+
+      rendered_text = @s.render
+      rendered_text.should_not match(/http:\/\/someurl\.com\/image\.jpg/)
+      rendered_text.should match(/\$mbc2: "Another URL";/)
+
+      @s.mbc2.value = %Q("Some third URL")
+      @s.mbc2.value.should == %Q("Some third URL")
+      rendered_text = @s.render
+      rendered_text.should_not match(/\$mbc2: "Another URL";/)
+      rendered_text.should match(/\$mbc2: "Some third URL";/)
+    end
+
+    it "should render the correct values" do
+      text_old = %{// @name Masthead Background Image
+// @kind file
+// @description Background image.
+$mbc2: "http://someurl.com/image.jpg";}
+      text_new = %{// @name Masthead Background Image
+// @kind file
+// @description Background image.
+$mbc2: "Another URL";}
+      @s = ActiveText::Base.new(text_old)
+      @s.mbc2.value = %Q("Another URL")
+      @s.render.should == text_new
+    end
+  end
+
+  describe "when there's no metadata" do
+    it "should not allow reading of data" do
+      text = %{// @name Masthead Background Image
+// @kind file
+// @description Background image.
+$mbc2: "http://someurl.com/image.jpg";
+$mbc: #555;}
+      @s = ActiveText::Base.new(text)
+      @s.mbc.should be_nil
+    end
+  end
+
+  it "should allow mass assignment" do
+    text = %{// @name Masthead Background Image
+// @kind file
+// @description Background image.
+$mbc2: "http://someurl.com/image.jpg";
+
+// @name Masthead BG Color
+// @kind color
+// @description Background color.
+$mbc: #555;}
+    @s = ActiveText::Base.new(text)
+    @s.update_attributes(:mbc2 => %Q("Another URL"), :mbc => nil)
+    @s.mbc2.value.should == %Q("Another URL")
+    @s.mbc.value.should == "#555"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'active_text'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: active_text
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Ramon Tayag
@@ -23,7 +23,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         hash: 3
         segments: 
@@ -80,7 +80,21 @@ dependencies:
   name: rcov
   version_requirements: *id004
   prerelease: false
-description: ActiveText aims to be able to read and replace "variables" in text files. This won't be exactly feel like ActiveRecord, but similar where it seems it should.
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: autotest
+  version_requirements: *id005
+  prerelease: false
+description: Aims to be able to read and replace "variables" in text in an active record manner. I don't claim that it behaves exactly like ActiveRecord - that is a much more complex beast than this will ever be.
 email: ramon@tayag.net
 executables: []
 
@@ -91,6 +105,8 @@ extra_rdoc_files:
 - README.textile
 files: 
 - .document
+- .rspec
+- .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -99,8 +115,12 @@ files:
 - VERSION
 - active_text.gemspec
 - lib/active_text.rb
+- lib/active_text/base.rb
+- lib/active_text/variable.rb
+- spec/active_text_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/ramon.tayag/active_text
+homepage: http://github.com/ramontayag/active_text
 licenses: 
 - MIT
 post_install_message: 
@@ -132,6 +152,7 @@ rubyforge_project:
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: "ActiveText : Text as ActiveRecord : Database. Sort of."
-test_files: []
-
+summary: "ActiveText : Text as ActiveRecord : Records. Sort of."
+test_files: 
+- spec/active_text_spec.rb
+- spec/spec_helper.rb