spaces_are_ok 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50b5c8bb4f715deea3aad77d77a806731f68764c
+  data.tar.gz: e1330ea83d035cdc61930038fe2468ff23500086
+SHA512:
+  metadata.gz: 4921e3819e2a031290432f24b20c588784499f16801237d4e8a527af72871fe68178fead26526fbbc284391a4791c05788290b99b7dda3b76785f132c41b5c23
+  data.tar.gz: eb9afc71b9867e2d3c54db88d0a67efdfe7bd93aa871b12d51a00b5c4d7cedb11a48340041b585eff78f0f1605563714dbd0ca8cf92392111e26fe47a5c50d79

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spaces_are_ok.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kim Ahlström
+
+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,281 @@
+[![Build Status](https://travis-ci.org/Kimtaro/spaces_are_ok.svg)](https://travis-ci.org/Kimtaro/spaces_are_ok) [![Code Climate](https://codeclimate.com/github/Kimtaro/spaces_are_ok/badges/gpa.svg)](https://codeclimate.com/github/Kimtaro/spaces_are_ok) [![Test Coverage](https://codeclimate.com/github/Kimtaro/spaces_are_ok/badges/coverage.svg)](https://codeclimate.com/github/Kimtaro/spaces_are_ok)
+
+# Spaces Are Ok
+
+Use natural language in your Ruby class and method names.
+
+Like this
+
+```ruby
+space_class("Scorecard for a player").new("Picard").space_method("Calculate the score from a game", game)
+```
+
+or the shorter and fancier
+
+```ruby
+ç("Scorecard for a player").new("Picard").ƒ("Calculate the score from a game", game)
+```
+
+instead of the mechanical and boring
+
+```ruby
+ScorecardForPlayer.new("Picard").calculate_new_score(game)
+```
+
+or the not very informative
+
+```ruby
+Scorecard.new("Picard").score(game)
+```
+
+## Why
+
+Naming things is famously one of the hard things in computer science[*](http://martinfowler.com/bliki/TwoHardThings.html), but programming languages aren't doing a very good job of helping us write fun and descriptive language.
+
+What if instead of `WritingLikeThis`, `having_to_read_this` or `BEING_SHOUTEN_AT` we could write and read regular language? Maybe it will help us write better programs? Or maybe it won't. But I thought it would be a fun experiment.
+
+## Installation
+
+This gem requires Ruby 2.1 or newer.
+
+Add this line to your application's Gemfile:
+
+    gem 'spaces_are_ok'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spaces_are_ok
+
+## Usage
+
+Ruby doesn't allow method calls with the keywords `class` and `def`, so we have to use slightly different syntax when defining and using our space friendly names. But it's not too bad.
+
+```ruby
+require 'spaces_are_ok'
+
+space_class("Greet someone") do
+  def initialize(name)
+    @name = name
+  end
+
+  space_method_def "Say hello", def _
+    "Hello, #{@name}"
+  end
+end
+
+greeter = space_class("Greet someone").new("Kim")
+greeter.space_method("Say hello") # => Hello, Kim!
+```
+
+Since it gets rather tedious to write `space_` all the time, I have included shorthand versions, so the above can be written like this:
+
+```ruby
+require 'spaces_are_ok'
+
+ç("Greet someone") do
+  def initialize(name)
+    @name = name
+  end
+
+  ∂ƒ "Say hello", def _
+    "Hello, #{@name}"
+  end
+end
+
+greeter = ç("Greet someone").new("Kim")
+greeter.ƒ("Say hello") # => Hello, Kim!
+```
+
+### Summary of functionality
+
+#### Defining a class
+
+##### Plain Ruby
+
+```ruby
+class LaunchSpaceShip
+  # Class definition
+end
+```
+
+##### Spaces Are Ok
+
+```ruby
+space_class("Launch space ship") do
+  # Class definition
+end
+```
+
+##### Spaces Are Ok shorthand
+
+```ruby
+ç("Launch space ship") do
+  # Class definition
+end
+```
+
+#### Using a class
+
+##### Plain Ruby
+
+```ruby
+LaunchSpaceShip.new
+```
+
+##### Spaces Are Ok
+
+```ruby
+space_class("Launch space ship").new
+```
+
+##### Spaces Are Ok shorthand
+
+```ruby
+ç("Launch space ship").new
+```
+
+#### Defining a module
+
+#####Plain Ruby
+
+```ruby
+module SpaceShipMotor
+  # Module definition
+end
+```
+
+##### Spaces Are Ok
+
+```ruby
+space_module("Space ship motor") do
+  # Module definition
+end
+```
+
+##### Spaces Are Ok shorthand
+
+```ruby
+ɱ("Space ship motor") do
+  # Module definition
+end
+```
+
+#### Using a module
+
+##### Plain Ruby
+
+```ruby
+include SpaceShipMotor
+```
+
+##### Spaces Are Ok
+
+```ruby
+include space_module("Space ship motor")
+```
+
+##### Spaces Are Ok shorthand
+
+```ruby
+include ɱ("Space ship motor")
+```
+
+#### Defining a method
+
+##### Plain Ruby
+
+```ruby
+def travel_to_a_planet(planet)
+  # Method body
+end
+```
+
+##### Spaces Are Ok
+
+```ruby
+space_method_def("Travel to a planet"), def _(planet)
+  # Method body
+end
+```
+
+##### Spaces Are Ok shorthand
+
+```ruby
+∂ƒ("Travel to a planet"), def_(planet)
+  # Method body
+end
+```
+
+#### Calling a method
+
+##### Plain Ruby
+
+```ruby
+travel_to_a_planet(planet)
+```
+
+##### Spaces Are Ok
+
+```ruby
+space_method("Travel to a planet", planet)
+```
+
+##### Spaces Are Ok shorthand
+
+```ruby
+ƒ("Travel to a planet", planet)
+```
+
+### You don't have to care about spelling
+
+If you're the adventurous type and don't want to worry about speling everything correctly all the time, then you don't have have to. Just turn on the `dont_worry_about_spelling`-mode.
+
+```ruby
+require 'spaces_are_ok/dont_worry_about_spelling'
+
+space_class("Greet someone") do
+  def initialize(name)
+    @name = name
+  end
+
+  space_method_def "Say hello", def _
+    "Hello, #{@name}"
+  end
+end
+
+greeter = space_class("Greeet someone").new("Kim")
+greeter.space_method("Say jello") # => Hello, Kim!
+```
+
+## But should I use it?
+
+Probably not.
+
+## Ideas for improvement
+
+- I haven't been able to figure out a way of doing this for variable names. I would prefer `space_variable("Number of vowels")` over `vwl_ctr`. Wouldn't you?
+- Patch Ruby so we could have this as a feature in the language. It could look something like this:
+
+```ruby
+class “Weather forecast”
+  def ‘will it rain tomorrow?’
+    puts "Time will tell"
+  end
+end
+
+“Weather forecast”.new.‘will it rain tomorrow?’ # => Time will tell
+```
+
+## Contributing
+
+1. Fork it
+2. Install the dependencies (`bundle install`)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Run the tests (`mtest test.rb`)
+7. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+task :default => :test
+
+task :test do
+  require './test.rb'
+end

data/lib/spaces_are_ok.rb

@@ -0,0 +1,17 @@
+require "spaces_are_ok/version"
+require "spaces_are_ok/classes_and_modules"
+require "spaces_are_ok/methods"
+require "spaces_are_ok/modify_the_kernel"
+
+module SpacesAreOk
+  def self.make_a_valid_name(possibly_invalid_name, separator)
+    name = possibly_invalid_name.gsub(%r< [^a-z0-9_] >ix) do |m|
+      "#{m.ord}_"
+    end
+    name.downcase
+  end
+
+  def self.find_a_matching_name(prospects, name)
+    prospects.detect { |prospect| prospect == name }
+  end
+end

data/lib/spaces_are_ok/classes_and_modules.rb

@@ -0,0 +1,63 @@
+module SpacesAreOk::ClassesAndModules
+  def self.get_class(original_name, superclass = Object, &class_definition)
+    creator = -> { Class.new(superclass) }
+    define_or_get_module_or_class(
+      original_name,
+      Class,
+      :class_eval,
+      creator,
+      &class_definition
+    )
+  end
+
+  def self.get_module(original_name, &module_definition)
+    creator = -> { Module.new }
+    define_or_get_module_or_class(
+      original_name,
+      Module,
+      :module_eval,
+      creator,
+      &module_definition
+    )
+  end
+
+  private
+
+  def self.define_or_get_module_or_class(original_name, type, evaluator, creator, &body)
+    name = get_name(original_name, type)
+
+    if !Object.const_defined?(name)
+      Object.const_set(name, creator.call)
+    end
+
+    module_or_class = Object.const_get(name)
+
+    if !body.nil?
+      module_or_class.send(evaluator, &body)
+    end
+
+    module_or_class
+  end
+
+  def self.get_name(original_name, type)
+    name = valid_class_or_module_name_from(original_name)
+    close_enough = closest_existing_name_for(name, type)
+    name = close_enough unless close_enough.nil?
+    name
+  end
+
+  def self.closest_existing_name_for(name, type)
+    names = Module.constants.select do |c|
+      next if c.to_s == 'Config' # Get rid of RbConfig/Config warning
+      Module.const_get(c).is_a?(type)
+    end
+
+    SpacesAreOk::find_a_matching_name(names, name)
+  end
+
+  def self.valid_class_or_module_name_from(original_name)
+    name = SpacesAreOk::make_a_valid_name(original_name, '')
+    name = "a_#{name}" if name.match(%r<^ [^a-z] >x)
+    name.capitalize
+  end
+end

data/lib/spaces_are_ok/dont_worry_about_spelling.rb

@@ -0,0 +1,12 @@
+require "spaces_are_ok"
+require "rubyfish"
+
+module SpacesAreOk
+  def self.find_a_matching_name(prospects, name)
+    names = prospects.find_all do |prospect|
+      RubyFish::Levenshtein.distance(name, prospect) <= 3
+    end
+
+    names.sort_by(&:size).first
+  end
+end

data/lib/spaces_are_ok/methods.rb

@@ -0,0 +1,27 @@
+module SpacesAreOk::Methods
+  def self.get_method(original_name, the_binding)
+    name = valid_method_name_from(original_name)
+
+    if !method_defined?(name)
+      close_enough = closest_method_name(name, the_binding)
+      if !close_enough.nil?
+        name = close_enough
+      end
+    end
+
+    name
+  end
+
+  private
+
+  def self.valid_method_name_from(original_name)
+    name = SpacesAreOk::make_a_valid_name(original_name, '_')
+    name = "a_#{name}" if name.match(%r<^ [^a-z] >x)
+    name
+  end
+
+  def self.closest_method_name(name, the_binding)
+    all_methods = the_binding.eval("methods") + the_binding.eval("private_methods")
+    SpacesAreOk::find_a_matching_name(all_methods, name)
+  end
+end

data/lib/spaces_are_ok/modify_the_kernel.rb

@@ -0,0 +1,40 @@
+module Kernel
+  # Classes
+  def space_class(*args, &class_definition)
+    SpacesAreOk::ClassesAndModules.get_class(*args, &class_definition)
+  end
+
+  def ç(*args, &class_definition)
+    space_class(*args, &class_definition)
+  end
+
+  # Modules
+  def space_module(*args, &module_definition)
+    SpacesAreOk::ClassesAndModules.get_module(*args, &module_definition)
+  end
+
+  def ɱ(*args, &class_definition)
+    space_module(*args, &class_definition)
+  end
+
+  # Method definition
+  def space_method_def(original_name, actual_method_name)
+    new_name = SpacesAreOk::Methods.get_method(original_name, binding)
+    binding.eval <<-EOS
+      alias_method :#{new_name}, :#{actual_method_name}
+    EOS
+  end
+
+  def ∂ƒ(original_name, actual_method_name)
+    space_method_def(original_name, actual_method_name)
+  end
+
+  # Method invocation
+  def space_method(original_name, *args, &block)
+    send(SpacesAreOk::Methods.get_method(original_name, binding), *args, &block)
+  end
+
+  def ƒ(original_name, *args, &block)
+    space_method(original_name, *args, &block)
+  end
+end

data/lib/spaces_are_ok/version.rb

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

data/spaces_are_ok.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spaces_are_ok/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spaces_are_ok"
+  spec.version       = SpacesAreOk::VERSION
+  spec.authors       = ["Kim Ahlström"]
+  spec.email         = ["kim.ahlstrom@gmail.com"]
+  spec.description   = %q{Allows the use of strings as class names, module names and method names}
+  spec.summary       = %q{Use strings as class, module and method names}
+  spec.homepage      = ""
+  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"
+  spec.add_development_dependency "maxitest", "~> 1.0.3"
+  spec.add_dependency "rubyfish", "~> 0.0.6"
+end

data/test.rb

@@ -0,0 +1,130 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+$: << File.expand_path('../lib', __FILE__)
+require 'maxitest/autorun'
+require 'spaces_are_ok'
+
+space_class("Greet the world") do
+  def initialize(name)
+    @name = name
+  end
+
+  def hi
+    greet("Hi")
+  end
+
+  space_method_def "say good bye", def _
+    "Good bye, #{@name}"
+  end
+
+  space_method_def "say good afternoon", def _
+    "Good afternoon, #{@name}"
+  end
+
+  private
+
+  def greet(greeting)
+    "#{greeting}, #{@name}!"
+  end
+end
+
+space_class("Shout greeting", space_class("Greet the world")) do
+  private
+
+  def greet(greeting)
+    super(greeting).upcase
+  end
+end
+
+space_module("A greeter") do
+  def greet
+    "Hello!"
+  end
+end
+
+space_class("I do nothing on my own") do
+  include space_module("A greeter")
+end
+
+class SpacesAreOkTest < Minitest::Test
+  def setup
+    require 'spaces_are_ok'
+  end
+
+  def test_make_a_valid_name
+    assert_equal "36__228__ncc45_170145_d47_12472_12515_12531_65309_12522_12517_12483_12463_12539_12500_12459_12540_12489_", SpacesAreOk::make_a_valid_name('$_ä_ncc-1701-d/ジャン＝リュック・ピカード', '_')
+  end
+
+  def test_instance_method_invocation_on_classes
+    assert_equal "Hi, Kim!", space_class("Greet the world").new("Kim").hi
+  end
+
+  def test_subclass
+    assert_equal "HI, KIM!", space_class("Shout greeting").new("Kim").hi
+  end
+
+  def test_module
+    assert_equal "Hello!", space_class("I do nothing on my own").new.greet
+  end
+
+  def test_method
+    assert_equal "Good afternoon, Kim", space_class("Greet the world").new("Kim").space_method("Say good afternoon")
+    assert_equal "Good bye, Kim", space_class("Greet the world").new("Kim").space_method("Say good bye")
+  end
+end
+
+class SpacesAreOkAndDontWorryAboutSpellingTest < Minitest::Test
+  def setup
+    require 'spaces_are_ok/dont_worry_about_spelling'
+  end
+
+  def test_misspelled_class
+    assert_equal space_class("Greet the world"), space_class("Kreet the vorld")
+  end
+
+  def test_misspelled_module
+    assert_equal space_module("A greeter"), space_module("B greeter")
+  end
+
+  def test_misspelled_method
+    assert_equal "Good afternoon, Kim", space_class("Greet the world").new("Kim").space_method("Say good afternooon")
+    assert_equal "Good bye, Kim", space_class("Greet the world").new("Kim").space_method("Say good buy")
+  end
+end
+
+ç("Test fancy class names", Minitest::Test) do
+  def self.a
+    "a"
+  end
+
+  def test_using_the_class_name
+    assert_equal "a", ç("Test fancy class names").a
+  end
+end
+
+ç("Test fancy module names", Minitest::Test) do
+  ɱ("Module for a") do
+    def a
+      "a"
+    end
+  end
+
+  extend ɱ("Module for a")
+
+  def test_using_the_class_name
+    assert_equal "a", ç("Test fancy module names").a
+  end
+end
+
+ç("Test fancy method names", Minitest::Test) do
+  class << self
+    ∂ƒ "return a", def _
+      "a"
+    end
+  end
+
+  def test_using_the_method_name
+    assert_equal "a", ç("Test fancy method names").ƒ("return a")
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: spaces_are_ok
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kim Ahlström
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-03 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'
+- !ruby/object:Gem::Dependency
+  name: maxitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: rubyfish
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+description: Allows the use of strings as class names, module names and method names
+email:
+- kim.ahlstrom@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spaces_are_ok.rb
+- lib/spaces_are_ok/classes_and_modules.rb
+- lib/spaces_are_ok/dont_worry_about_spelling.rb
+- lib/spaces_are_ok/methods.rb
+- lib/spaces_are_ok/modify_the_kernel.rb
+- lib/spaces_are_ok/version.rb
+- spaces_are_ok.gemspec
+- test.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Use strings as class, module and method names
+test_files: []