frappuccino 0.0.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3aa6c347af81d9a074803f7be38c360db41adee4
+  data.tar.gz: 49da3f4765330f9ad73de449aa3080454f9f49e2
+SHA512:
+  metadata.gz: 68c592a44ab4e948adfa4b8bb4214438cf3282cd9a3ce6047c436ad19471fa440b7d9703afc3fd0d9da386cc2873cc9091b7d80abdc8436973df00d0a79b4c40
+  data.tar.gz: cf1dc7f6d0394e3587714d668ab2a9aa304089ab4c5c239b7bbb8f406818ead40e6aa35dcc6c81c07ee236294090911018531eb3f96aa4484b5a0d902f420a04

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/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - rbx-nightly-19mode
+  - jruby-19mode
+allow_failures:
+  - rvm: rbx-nightly-19mode

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in frappuccino.gemspec
+gemspec
+
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steve Klabnik
+
+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,104 @@
+# Frappuccino
+
+Functional Reactive Programming for Ruby.
+
+[![Build Status](https://travis-ci.org/steveklabnik/frappuccino.png?branch=master)](https://travis-ci.org/steveklabnik/frappuccino) [![Code Climate](https://codeclimate.com/github/steveklabnik/frappuccino.png)](https://codeclimate.com/github/steveklabnik/frappuccino) [![Coverage Status](https://coveralls.io/repos/steveklabnik/frappuccino/badge.png?branch=master)](https://coveralls.io/r/steveklabnik/frappuccino)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'frappuccino', github: "steveklabnik/frappuccino"
+```
+
+(I'm hoping that @yoka will give me the gem name, until then, you
+must install from GitHub.)
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ git clone https://github.com/steveklabnik/frappuccino
+    $ cd frappuccino
+    $ bundle
+    $ rake install
+
+## Usage
+
+Basically, this:
+
+```ruby
+require 'frappuccino'
+
+class Button
+  def push
+    emit(:pushed) # emit sends a value into the stream
+  end
+end
+
+button = Button.new
+stream = Frappuccino::Stream.new(button)
+
+counter = stream
+            .map {|event| event == :pushed ? 1 : 0 } # convert events to ints
+            .inject(0) {|sum, n| sum + n } # add them up
+
+counter.now # => 0
+
+button.push
+button.push
+button.push
+
+counter.now # => 3
+
+button.push
+
+counter.now # => 4
+```
+
+You can also map via a hash, if you prefer:
+
+```ruby
+.map(:pushed => 1, :default => 0)
+```
+
+You can also register callbacks to a Stream. These will executed for
+each event that occurs in the Stream:
+
+```ruby
+stream.on_value do |event|
+  puts "I got a #{event}!"
+end
+```
+
+You can combine two streams together:
+
+```ruby
+merged_stream = Frappuccino::Stream.merge(stream_one, stream_two)
+
+# or
+
+merged_stream = Frappuccino::Stream.new(button_one, button_two)
+```
+
+You can select events from a stream, too:
+
+```ruby
+stream = Frappuccino::Stream.new(button, something_else)
+filtered_stream = stream.select{|event| event == :pushed }
+
+filtered_stream.on_value do |event|
+  # event will only ever be :pushed
+end
+```
+
+## Contributing
+
+1. Fork it
+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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.ruby_opts = ["-w"]
+  t.verbose = true
+end
+
+task :default => :test

data/frappuccino.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'frappuccino/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "frappuccino"
+  spec.version       = Frappuccino::VERSION
+  spec.authors       = ["Steve Klabnik"]
+  spec.email         = ["steve@steveklabnik.com"]
+  spec.description   = %q{A library to do Functional Reactive Programming in Ruby.}
+  spec.summary       = %q{Functional Reactive Programming in Ruby.}
+  spec.homepage      = "https://github.com/steveklabnik/frappuccino"
+  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/frappuccino.rb

@@ -1,140 +1,3 @@
-require "erb"
-require "fileutils"
-class Frappuccino
-  attr_writer :files, :documentations, :doctree, :title
-  def initialize title, files
-    if File.directory? files
-      docfiles = []
-      Dir.glob("#{files}/*").each do |file|
-        docfiles.push(file) unless File.directory? file
-      end
-      files = docfiles
-    end
-    @files = files
-    @documentations = []
-    @doctree = {:namespaces => {}}
-    @title = title
-    iterate_files
-    documentations_to_doctree
-    # sort alphabetically
-    @doctree[:namespaces] = @doctree[:namespaces].sort_by {|k,v| k}
-    generate_html
-  end
-
-  def iterate_files
-    for file in @files
-      File.open(file) do |opened_file|
-        puts "* Parsing documentation from #{file}"
-        collect_documentation opened_file
-      end
-    end
-  end
-
-  # parses documentation bodies
-  def collect_documentation opened_file
-    doc_start = false
-    current_documentation = []
-    opened_file.each_line do |line|
-      # documentation starts here
-      if line.include?("###") and !doc_start
-        doc_start = true
-      # documentation ends here
-      elsif line.include?("###") and doc_start
-        @documentations.push current_documentation
-        current_documentation = []
-        doc_start = false
-      # in the middle of documentation
-      elsif doc_start
-        current_documentation.push line
-      end
-    end
-  end
-
-  def documentations_to_doctree
-    @documentations.each do |docbody|
-      doctree_format docbody
-    end
-  end
-
-  # transforms array of strings to doctree hash
-  def doctree_format docbody
-    doctree = {}
-    value_regexp = /^.*:\s(.*)/
-    namespace_arr = []
-    namespace_tree = {}
-    function_name = nil
-    object_name = nil
-    description = ""
-    rest_is_description = false
-
-    docbody.each do |line|
-      if line.match(/^\s*function/)
-        function_name = line.match(value_regexp)[1]
-      elsif line.match(/^\s*object/)
-        object_name = line.match(value_regexp)[1]
-      elsif line.match(/^\s*description/)
-        rest_is_description = true
-      elsif line.match(/^\s*namespace/)
-        namespace_arr = line.match(value_regexp)[1].split(".")
-      elsif rest_is_description
-        description += line
-      end
-    end
-
-    full_namespace = namespace_arr.join(".")
-
-
-    if !function_name.nil?
-      docdata = {:full_namespace => full_namespace, :functions => [{:function_name => function_name, :description => description}]}
-    elsif !object_name.nil?
-      docdata = {:full_namespace => full_namespace, :objects => [{:object_name => object_name, :description => description}]}
-    else
-      if rest_is_description
-        docdata = {:full_namespace => full_namespace, :description => description}
-      else
-        docdata = {:full_namespace => full_namespace}
-      end
-    end
-
-    namespace_is_added = false
-    @doctree[:namespaces].each do |key, value|
-      namespace_is_added = true if key == full_namespace
-    end
-
-    if namespace_is_added
-      @doctree[:namespaces][full_namespace] = deep_safe_merge(@doctree[:namespaces][full_namespace], docdata)
-    else
-      @doctree[:namespaces][full_namespace] = docdata
-    end
-
-  end
-
-
-  def generate_html
-    template = ERB.new File.new("#{File.dirname(__FILE__)}/../template/index.erb").read
-    rendered_template = template.result(binding)
-    FileUtils.mkdir "docs" unless File.directory? "docs"
-    File.open("docs/index.html", "w") do |f|
-      f.write rendered_template
-    end
-    FileUtils.cp("#{File.dirname(__FILE__)}/../template/bg.png", "docs/bg.png")
-    puts "* Documentation file generated (docs/index.html)"
-  end
-
-  # helpers:
-
-  def deep_safe_merge(source_hash, new_hash)
-    source_hash.merge(new_hash) do |key, old, new|
-      if new.respond_to?(:blank) && new.blank?
-         old
-      elsif (old.kind_of?(Hash) and new.kind_of?(Hash))
-         deep_merge(old, new)
-      elsif (old.kind_of?(Array) and new.kind_of?(Array))
-         old.concat(new).uniq
-      else
-         new
-      end
-    end
-  end
-
-end
+require "frappuccino/version"
+require "frappuccino/stream"
+require "frappuccino/property"

data/lib/frappuccino/property.rb

@@ -0,0 +1,16 @@
+module Frappuccino
+  class Property
+    def initialize(zero, stream)
+      @value = zero
+      stream.add_observer(self)
+    end
+
+    def now
+      @value
+    end
+
+    def update(value)
+      @value = value
+    end
+  end
+end

data/lib/frappuccino/source.rb

@@ -0,0 +1,14 @@
+require 'observer'
+
+module Frappuccino
+  module Source
+    def self.extended(object)
+      object.extend(Observable)
+    end
+
+    def emit(value)
+      changed
+      notify_observers(value)
+    end
+  end
+end

data/lib/frappuccino/stream.rb

@@ -0,0 +1,112 @@
+# encoding: utf-8
+
+# before we require all of the subclasses, we need to have Stream defined
+module Frappuccino
+  class Stream
+  end
+end
+
+require 'frappuccino/source'
+
+require 'frappuccino/stream/map'
+require 'frappuccino/stream/select'
+require 'frappuccino/stream/zip'
+require 'frappuccino/stream/drop'
+require 'frappuccino/stream/scan'
+require 'frappuccino/stream/take'
+
+def not_implemented(m, message)
+  define_method m do |*args, &blk|
+    raise NotImplementedError, "##{m} is not supported, because #{message}."
+  end
+end
+
+module Frappuccino
+  class Stream
+    include Observable
+
+    def initialize(*sources)
+      sources.each do |source|
+        source.extend(Frappuccino::Source).add_observer(self)
+      end
+    end
+
+    def update(event)
+      occur(event)
+    end
+
+    def count(*args, &blk)
+      stream = if args.count > 0
+        self.select { |value| value == args.first }
+      elsif blk
+        self.select { |value| blk.call(value) }
+      else
+        self
+      end
+
+      Property.new(0, stream.scan(0) { |last| last + 1 })
+    end
+
+    not_implemented(:cycle, "it relies on having a end to the Enumerable")
+    not_implemented(:all?,  "it needs a stream that terminates.")
+    not_implemented(:chunk, "it needs a stream that terminates.")
+    not_implemented(:any?,  "it could resolve to ⊥. You probably want #select")
+    not_implemented(:find,  "it could resolve to ⊥. You probably want #select")
+
+    alias :detect :find
+
+    def map(hash = nil, &blk)
+      blk = lambda { |event| hash.fetch(event) { hash[:default] } } if hash
+      Map.new(self, &blk)
+    end
+    alias :collect :map
+    alias :map_stream :map
+
+    def drop(n)
+      Drop.new(self, n)
+    end
+
+    def take(n)
+      Take.new(self, n)
+    end
+
+    def inject(start, &blk)
+      Property.new(start, self.scan(start, &blk))
+    end
+
+    def select(&blk)
+      Select.new(self, &blk)
+    end
+
+    def zip(stream)
+      Zip.new(self, stream)
+    end
+
+    def scan(zero, &blk)
+      Scan.new(self, zero, &blk)
+    end
+
+    def on_value(&blk)
+      callbacks << blk
+    end
+
+    def self.merge(stream_one, stream_two)
+      new(stream_one, stream_two)
+    end
+
+    protected
+
+    def occur(value)
+      callbacks.each do |callback|
+        callback.call(value)
+      end
+
+      changed
+      notify_observers(value)
+    end
+
+    def callbacks
+      @callbacks ||= []
+    end
+  end
+end