lunfardo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2eedc2a9d1490bcc9b8b796fba86a8d1de87e748
+  data.tar.gz: a9dd417aaff5a9342f1f27d091c431ae18fa275f
+SHA512:
+  metadata.gz: 5e28a670b94f828be87bbef17877df4e7f721f67ec81996120748b1e7857dbe0d8eb014ed2a5b12c941f547ae7f3dddcf46be577465abb380f7504836bc14c03
+  data.tar.gz: 7405789a3ded3bb148b97b268ed7ec60c582bda9fc00b6bdcbed8325035eb9d8de62e303dcf88fb53d3b3f0e89e210eabb1b6be472273cfbedb471730a58f30b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--require spec-helper
+--color

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in Lunfardo.gemspec
+gemspec
+
+gem 'rspec', require: false
+gem 'simplecov', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Martin Rubi
+
+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,408 @@
+# Lunfardo
+
+Lunfardo is a framework to easily define simple (and not quite so simple) DSLs.
+For example it can be used to define an object configuration DSL.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lunfardo', '~> 0.1'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lunfardo
+
+## Usage
+
+Suppose you have the class
+
+```ruby
+class SomeClass
+	def self.filename()
+		@filename
+	end
+
+	def self.set_filename(filename)
+		@filename = filename
+	end
+end
+```
+
+and you would like to make it configurable:
+
+```ruby
+SomeClass.configure do
+	filename 'some_file.txt'
+end
+```
+
+To do that, define the DSL:
+
+```ruby
+include 'lunfardo'
+
+class SomeClassConfigurationDSL
+	include CabezaDeTermo::Lunfardo::Behaviour
+
+	on :filename do |name|
+		perform do |name|
+			context.set_filename(name)
+		end
+	end
+end
+```
+
+and then add the `configure` method to `SomeClass`:
+
+```ruby
+class SomeClass
+	def self.filename()
+		@filename
+	end
+
+	def self.set_filename(filename)
+		@filename = filename
+	end
+
+	def self.configure(&block)
+		SomeClassConfigurationDSL.evaluate_on(self, &block)
+	end
+end
+```
+
+and that's it. This is the simpliest use, but it can be used for more complex DSLs too.
+
+## API
+
+### Accessing the context from the DSL
+
+You can access the context from the DSL sending `context`:
+
+```ruby
+include 'lunfardo'
+
+class SomeClassConfigurationDSL
+	include CabezaDeTermo::Lunfardo::Behaviour
+
+	on :filename do |name|
+		perform do |name|
+			context.files << name
+		end
+	end
+end
+
+# to be used like
+
+SomeClass.configure do
+	filename 'file_1.txt'
+	filename 'file_2.txt'
+end
+```
+
+### Evaluating code at the begining of a configuration scope
+
+You can evaluate code before evaluating the rest of the configuration:
+
+```ruby
+include 'lunfardo'
+
+class SomeClassConfigurationDSL
+	include CabezaDeTermo::Lunfardo::Behaviour
+
+	on :filenames do
+		before do
+			context.files = []
+		end
+
+		on :filename do |name|
+			perform do |name|
+				context.files << name
+			end
+		end
+	end
+end
+
+# to be used like
+
+SomeClass.configure do
+	filenames do
+		filename 'file_1.txt'
+		filename 'file_2.txt'
+	end
+end
+```
+
+### Evaluating code at the end of a configuration scope
+
+You can evaluate code after evaluating the rest of the configuration:
+
+```ruby
+include 'lunfardo'
+
+class SomeClassConfigurationDSL
+	include CabezaDeTermo::Lunfardo::Behaviour
+
+	on :filenames do
+		attr_reader :files
+
+		before do
+			@files = []
+		end
+
+		on :filename do |name|
+			perform do |name|
+				outer.files << name
+			end
+		end
+
+		after do
+			context.files = @files.join(', ')
+		end
+	end
+end
+
+# to be used like
+
+SomeClass.configure do
+	filenames do
+		filename 'file_1.txt'
+		filename 'file_2.txt'
+	end
+end
+```
+
+The `#after` scope will also return its evaluation:
+
+```ruby
+include 'lunfardo'
+
+class BloatedJoinDSL
+	include CabezaDeTermo::Lunfardo::Behaviour
+
+	on :filenames do
+		attr_reader :files
+
+		before do
+			@files = []
+		end
+
+		on :filename do |name|
+			perform do |name|
+				outer.files << name
+			end
+		end
+
+		after do
+			@files.join(', ')
+		end
+	end
+end
+
+# to be used like
+
+files = BloatedJoinDSL.evaluate do
+	filenames do
+		filename 'file_1.txt'
+		filename 'file_2.txt'
+	end
+end
+
+files == ['file_1.txt', 'file_2.txt']
+```
+
+### Defining instance variables and methods in a configuration scope
+
+In the previous example you can see that you can use instance variables and methods inside a configuration scope.
+
+You can also define any method using `define`:
+
+```ruby
+include 'lunfardo'
+
+class BloatedJoinDSL
+	include CabezaDeTermo::Lunfardo::Behaviour
+
+	on :filenames do
+		attr_reader :files
+
+		define :extension do
+			'.txt'.freeze
+		end		
+
+		before do
+			@files = []
+		end
+
+		on :filename do |name|
+			perform do |name|
+				outer.files << name + extension
+			end
+		end
+
+		after do
+			@files.join(', ')
+		end
+	end
+end
+
+# to be used like
+
+files = BloatedJoinDSL.evaluate do
+	filenames do
+		filename 'file_1'
+		filename 'file_2'
+	end
+end
+
+files == ['file_1.txt', 'file_2.txt']
+```
+
+### Accessing the outer scope of a configuration scope
+
+If you need to access the outer scope of your current scope, send `outer`
+
+```ruby
+on :filename do |name|
+	perform do |name|
+		outer.files << name
+	end
+end
+```
+
+or if you need to reach an outer scope several layers above
+
+```ruby
+on :filename do |name|
+	perform do |name|
+		outer(3).files << name
+	end
+end
+```
+
+### Handling a block instead of evaluating it
+
+Sometimes you won't want to evaluate a block but to handle it in a custom way.
+
+In that case, you must declare in you scope definition (at the `#on` message) that you expect the `&block` parameter:
+
+```ruby
+class ValidationsMessageLibraryDSL
+	include CabezaDeTermo::Lunfardo::Behaviour
+
+	dsl do
+		attr_reader :messages
+
+		before do
+			@messages = Hash[]
+		end
+
+		on :message_for do |validation_name, &message_block|
+			perform do |validation_name, &message_block|
+				outer.messages[validation_name] = message_block
+			end
+		end
+
+		after do
+			@messages
+		end
+	end
+end
+
+# to be used like
+
+messages = ValidationsMessageLibraryDSL.evaluate do
+	message_for :presence do |validation|
+		"can not be left blank"
+	end
+
+	message_for :format do |validation|
+		"doesn't match expected format: #{validation.expected_value}"
+	end
+end
+```
+
+### Defining recursive configurations
+
+You can define a configuration using recursion like in the example:
+
+```ruby
+class ParamsDSL
+	include CabezaDeTermo::Lunfardo::Behaviour
+
+	dsl do
+		on :params do
+			attr_reader :params
+
+			before do
+				@params = Hash[]
+			end
+
+			on :param do
+				attr_reader :name
+				attr_reader :params
+
+				before do |name, value = nil|
+					@name = name
+					@params = outer.params
+				end
+
+				perform do |name, value = nil|
+					@params[name] = value.nil? ? Hash[] : value
+				end
+
+				on :param do
+					attr_reader :name
+					attr_reader :params
+
+					before do |name, value = nil|
+						@name = name
+						@params = outer.params[outer.name]
+					end
+
+					perform do |name, value = nil|
+						@params[name] = value.nil? ? Hash[] : value
+					end
+
+					recursive :param, scope: self
+				end
+			end
+
+			after do
+				@params
+			end
+		end
+	end
+end
+
+# to be used like
+
+params = ParamsDSL.evaluate do
+	params do
+		param :client do
+			param :name, 'Juan Salvo'
+			param :address do
+				param :city, 'Buenos Aires'
+			end
+		end
+	end
+end
+
+params == {:client => {:name=>"Juan Salvo ", :address=>{:city=>"Buenos Aires"}}}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cabeza-de-termo/lunfardo.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/lunfardo/behaviour.rb

@@ -0,0 +1,28 @@
+module CabezaDeTermo
+	module Lunfardo
+		module Behaviour
+			def self.included(base_class)
+				base_class.extend ClassMethods
+			end
+
+			module ClassMethods
+				def dsl(&block)
+					@root_scope = new_root_scope(&block)
+					@root_scope.instance_eval(&block)
+				end
+
+				def new_root_scope(&block)
+					Lunfardo::Scope.new_scope_class(name: :root_scope, &block)
+				end
+
+				def evaluate(&block)
+					evaluate_on(nil, &block)
+				end
+
+				def evaluate_on(context, &block)
+					@root_scope.new(context, nil)._evaluate(&block)
+				end
+			end
+		end
+	end
+end

data/lib/lunfardo/error.rb

@@ -0,0 +1,6 @@
+module CabezaDeTermo
+	module Lunfardo
+		class Error < RuntimeError
+		end
+	end
+end

data/lib/lunfardo/scope.rb

@@ -0,0 +1,146 @@
+module CabezaDeTermo
+	module Lunfardo
+		class Scope
+			class << self
+				def new_scope_class(name:, &block)
+					Class.new(self) do
+						set_scope_name name
+						infere_block_as_parameter_from(block)
+					end
+				end
+
+				# Accessing
+
+				def set_scope_name(name)
+					@scope_name = name.to_sym
+				end
+
+				def scope_name()
+					@scope_name
+				end
+
+				def infere_block_as_parameter_from(block)
+					@block_as_parameter = 
+						!block.nil? && !block.parameters.empty? &&
+						block.parameters.last[0] == :block
+				end
+
+				def block_as_parameter?()
+					@block_as_parameter
+				end
+
+				def scopes()
+					@scopes ||= Hash[]
+				end
+
+				# Defining the DSL
+
+				def define(method_name, &block)
+					define_method(method_name, &block)
+				end
+
+				def before(&block)
+					define(:before, &block)
+				end
+
+				def perform(*params, &block)
+					define(:perform, &block)
+				end
+
+				def on(method_name, block_param: false, &block)
+					scopes[method_name] = Scope.new_scope_class(name: method_name, &block)
+
+					scopes[method_name].instance_exec(&block)
+				end
+
+				def after(&block)
+					raise_error("#after method must receive a block argument") if block.nil?
+
+					define(:after, &block)
+				end
+
+				def recursive(scope_name, scope:)
+					scopes[scope_name] = scope
+				end
+
+				# Raising errors
+
+				def raise_error(message)
+					raise Lunfardo::Error.new(message)
+				end
+			end
+
+			# Initializing
+
+			def initialize(context, outer_scope)
+				@context = context
+				@outer_scope = outer_scope
+			end
+
+			# Accessing
+
+			def _scope_at(scope_name)
+				_scopes.fetch(scope_name.to_sym)
+			end
+
+			def _scope_name()
+				self.class.scope_name
+			end
+
+			def _block_as_parameter?()
+				self.class.block_as_parameter?
+			end
+
+			def _scopes()
+				self.class.scopes
+			end
+
+			# Asking
+
+			def _includes_scope?(scope_name)
+				_scopes.key?(scope_name.to_sym)
+			end
+
+			# Evaluating
+
+			def context()
+				@context
+			end
+
+			def outer(n = 1)
+				(1..n-1).inject(@outer_scope) do |outer_scope, i|
+					outer.outer
+				end
+			end
+
+			def _evaluate(*params, &block)
+				result = send(:before, *params, &block) if respond_to?(:before)
+
+				result = send(:perform, *params, &block) if respond_to?(:perform)
+
+				result = instance_exec(*params, &block) unless block.nil? || _block_as_parameter?
+
+				result = send(:after, *params, &block) if respond_to?(:after)
+
+				result
+			end
+
+			def method_missing(method_name, *params, &block)
+				return _raise_missing_scope_error(method_name) unless _includes_scope?(method_name)
+
+				_scope_at(method_name).new(@context, self)._evaluate(*params, &block)
+			end
+
+			# Raising errors
+
+			def _raise_missing_scope_error(method_name)
+				path = (_scope_path << method_name).join('.')
+				self.class.raise_error("The scope '#{path}' is not defined")
+			end
+
+			def _scope_path
+				outer.nil? ? [_scope_name] : outer._scope_path << _scope_name
+			end
+		end
+	end
+end

data/lib/lunfardo/version.rb

@@ -0,0 +1,5 @@
+module CabezaDeTermo
+	module Lunfardo
+	  VERSION = "0.1.0"
+	end
+end

data/lib/lunfardo.rb

@@ -0,0 +1,5 @@
+require 'lunfardo/version'
+
+require 'lunfardo/error'
+require 'lunfardo/scope'
+require 'lunfardo/behaviour'

data/lunfardo.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lunfardo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lunfardo"
+  spec.version       = CabezaDeTermo::Lunfardo::VERSION
+  spec.authors       = ["Martin Rubi"]
+  spec.email         = ["martinrubi@gmail.com"]
+
+  spec.summary       = %q{A framework to easily define simple DSLs}
+  spec.homepage      = "https://github.com/cabeza-de-termo/lunfardo"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: lunfardo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martin Rubi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- martinrubi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lunfardo.rb
+- lib/lunfardo/behaviour.rb
+- lib/lunfardo/error.rb
+- lib/lunfardo/scope.rb
+- lib/lunfardo/version.rb
+- lunfardo.gemspec
+homepage: https://github.com/cabeza-de-termo/lunfardo
+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.6.3
+signing_key: 
+specification_version: 4
+summary: A framework to easily define simple DSLs
+test_files: []