rbcss 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34613909c22009956e41b30702bf8b59891dbbf6
-  data.tar.gz: 648787ac4d7dbb4652c99fa820473702f466ecec
+  metadata.gz: c8f0b828893535a4825691f879d38dbb81c8e742
+  data.tar.gz: 20ef37044748c197e9f89d0520aa9ddca550e20b
 SHA512:
-  metadata.gz: 4936a3196561ef88fcdb6329bf546d0978d786dc898f9b0db5ccb5c6c2fe4ee4c4b801ed728b55e8fb4452e62a5ba32f977366c6827eb909c9954a4993d524bc
-  data.tar.gz: accf51e73db20a9a0b4ac36dad22f533a9f7381bf40e127c2136d0a138b8cfcddd87966557d2f0e16d9fba0b4ac78e920559fa060b8e613dce445b4668cce4d5
+  metadata.gz: d6f971cff23c305b0c61ad0c524b1041339c6cf3681d660a5de9b4332d6bc1e8d2de04b5003d9c5079fc563fd051dba5a84913dfab38e8bd879cfc2f37ffb86b
+  data.tar.gz: 98ea24e00b3239c62a1c3f8a06d3e4bc0fed8efd9b5a4ac82a119954d0835f81303c9db7513fc5585b3eea3dc6aaec12b4b92a144c0f4e588844f39ef38dc17e

data/README.md

@@ -1,6 +1,8 @@
-# Rbcss
+# RBCSS
 
-TODO: Write a gem description
+This is a Ruby DSL library to express the CSS structure as Ruby code. Expressing CSS using a DSL permits the use of all the capabilities of the host language like: functions, classes, modules, variables, hashes, array etc.
+
+This library does not intend to make CSS property or value validations, this was left to CSS itself. The purpose here is add dynamic capabilities while writing CSS code.
 
 ## Installation
 
@@ -20,11 +22,71 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic Usage
+In a ruby file, require css and pass a block to CSS.style function:
+
+```ruby
+require 'css'
+
+CSS.style do
+  to("body"){
+    background_color "green"
+  }
+  to("section.main div:nth-of-type(1)"){
+    width "100%"
+    height "64px"
+  }
+end
+```
+Run your file with Ruby and the output will be echoed to $stdout.
+
+### Writing to a file
+
+You can add a $stdout.reopen above CSS.style call to change the $stdout to a file with the same name as your Ruby file but with .css extension:
+
+```ruby
+require 'css'
+
+$stdout.reopen("#{$0.gsub('rb', 'css')}")
+CSS.style do
+  #...
+end
+```
+or you can use shell:
+
+    $ ruby mycss.rb > mycss.css
+
+### Adding functionality
+
+You can create mixins with modules:
+
+```ruby
+require 'css'
+
+module Shadow
+  def shadow(color: "grey")
+    box_shadow "0px 0px 7px 1px #{color}"
+    _webkit_shadow "0px 0px 7px 1px #{color}"
+  end
+end
+
+CSS.style do
+  extend Shadow
+
+  to("body"){
+    background_color "green"
+  }
+  to("section.main div:nth-of-type(1)"){
+    width "100%"
+    height "64px"
+    shadow "rgba(0, 0, 0, 0.12)"
+  }
+end
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/rbcss/fork )
+1. Fork it ( https://github.com/IvanOM/rbcss/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/features/convert_ruby_to_css.feature

@@ -0,0 +1,41 @@
+Feature: Converting Ruby DSL code to CSS
+
+  In order to have flexibility to write CSS
+  As an user
+  I want to write CSS in Ruby DSL and execute the file
+
+  Scenario: A simple block of code
+    Given a file named "mycss.rb" with:
+      """
+      require 'css'
+
+      CSS.style do
+        to('body'){
+          _webkit_animation "expand 1s linear"
+        }
+      end
+      """
+    When I run `ruby mycss.rb`
+    Then the output should contain:
+      """
+      body{-webkit-animation:expand 1s linear;}
+      """
+
+  Scenario: A nested block of code
+    Given a file named "mycss.rb" with:
+      """
+      require 'css'
+
+      CSS.style do
+        to('@media (max-width: 800px)'){
+          to('body'){
+            _webkit_animation "expand 1s linear"
+          }
+        }
+      end
+      """
+    When I run `ruby mycss.rb`
+    Then the output should contain:
+      """
+      @media (max-width: 800px){body{-webkit-animation:expand 1s linear;}}
+      """

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/lib/css.rb

@@ -1,21 +1,28 @@
-$stdout.reopen("#{$0.gsub('rb', 'css')}")
 module CSS
 
+  # Send a message to the module_eval method of CSS module. It is just an Alias.
+  # @param &block [Proc] the code block to be executed in the CSS context
   def self.style &block
     send :module_eval, &block
   end
 
+  # Write a css selector declaration to $stdout
+  # @param selector [String] the selector name or string
   def self.selector selector, &block
     $stdout.write "#{selector}{"; yield; $stdout.write "}"
   end
 
+  # Write a css property declaration with the name of the called method
+  # @param method [Symbol] the called method name as a symbol
   def self.property method, *args, &block
     $stdout.write "#{method.to_s.gsub('_', '-')}:#{args[0]};"
   end
 
+  private
+
   def self.method_missing name, *args, &block
-      send(:selector, *args, &block) if args[0] and block
-      send(:property, name, *args, &block) if args[0] and !block
+    send(:selector, *args, &block) if block
+    send(:property, name, *args, &block) if args[0] and !block
   end
 
 end

data/lib/rbcss/version.rb

@@ -1,3 +1,3 @@
 module Rbcss
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/rbcss.rb

@@ -2,7 +2,4 @@ require "rbcss/version"
 
 module Rbcss
 
-  class RubyCSS
-
-  end
 end

data/rbcss.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Rbcss::VERSION
   spec.authors       = ["Ivan"]
   spec.email         = ["ivan.eng.controle@gmail.com"]
-  spec.summary       = %q{A Ruy DSL to generate css.}
+  spec.summary       = %q{A Ruby DSL to generate css.}
   spec.description   = %q{This command line application generates css stylesheets from a Ruby DSL code.}
   spec.homepage      = ""
   spec.license       = "MIT"
@@ -20,4 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "cucumber", "~> 1.0"
+  spec.add_development_dependency "aruba", "~> 0.6"
+  spec.add_development_dependency "rspec", "~> 3.1"
 end

data/spec/css_spec.rb

@@ -0,0 +1,63 @@
+require "css"
+
+RSpec.describe CSS, :type => :module do
+  describe "#style" do
+    it "calls module_eval method" do
+      expect(CSS).to receive(:module_eval)
+      CSS.style do
+      end
+    end
+  end
+
+  describe "#property" do
+    it "prints a css property declaration to $stdout" do
+      expect{
+        CSS.style do
+          property "color", "green"
+        end
+      }.to output("color:green;").to_stdout
+    end
+  end
+
+  describe "#selector" do
+    it "prints a css selector declaration to $stdout" do
+      expect{
+        CSS.style do
+          selector("body"){}
+        end
+      }.to output("body{}").to_stdout
+    end
+
+    it "yields to a block with properties declarations" do
+      expect{
+        CSS.style do
+          selector("body"){
+            color "green"
+          }
+        end
+      }.to output("body{color:green;}").to_stdout
+    end
+  end
+
+  describe "calls to the inexistent method to" do
+    context "with an argument and a block" do
+      it "prints a css selector declaration to $stdout" do
+        expect{
+          CSS.style do
+            to("body"){}
+          end
+        }.to output("body{}").to_stdout
+      end
+    end
+
+    context "with just an argument" do
+      it "prints a css property declaration to $stdout" do
+        expect{
+          CSS.style do
+            to "body"
+          end
+        }.to output("to:body;").to_stdout
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbcss
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Ivan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-21 00:00:00.000000000 Z
+date: 2014-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,12 +38,53 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 description: This command line application generates css stylesheets from a Ruby DSL
   code.
 email:
 - ivan.eng.controle@gmail.com
-executables:
-- rbcss
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -52,11 +93,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/rbcss
+- features/convert_ruby_to_css.feature
+- features/support/env.rb
 - lib/css.rb
 - lib/rbcss.rb
 - lib/rbcss/version.rb
 - rbcss.gemspec
+- spec/css_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -77,8 +120,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
-summary: A Ruy DSL to generate css.
-test_files: []
+summary: A Ruby DSL to generate css.
+test_files:
+- features/convert_ruby_to_css.feature
+- features/support/env.rb
+- spec/css_spec.rb

data/bin/rbcss

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-
-require "rbcss"
-require "css"
-
-rubycss = Rbcss::RubyCSS.new
-
-file = ARGV[0]
-$stdout.reopen("#{file}.css", "w")
-require "#{file}"