MIT-LICENSE @@ -1,25 +1,45 @@ = About -Fluently is a JavaScript toolkit for creating "Fluent Interfaces"[http://martinfowler.com/bliki/FluentInterface.html]. With Fluently, you can create an object thus: +Fluently is a JavaScript toolkit for creating FluentInterfaces[http://martinfowler.com/bliki/FluentInterface.html]. + +With Fluently, you can do this: + var o = Fluently.make(function(define) { + define('fn1', function() {console.info('called fn1')}); + define('fn2', function() {console.info('called fn2')}); + define('fn3', function() {return 3}); + }); +to define an object with chained methods, that can be invoked thus: + o.fn1().fn2() // calls fn1 and then fn2 + o.fn2().fn1() // calls fn2 and then fn1 + o.fn1().fn3() // returns 3 (an explicit 'return' breaks the chain) + +You can also define modifiers, and aliases: var o = Fluently.make(function(define) { define('fn1', function() {console.info('called fn1')}); define('fn2', function() {console.info('called fn2')}); define.empty('and'); define.alias('fn3', 'fn1'); + define.modifier('not'); }); -to define an object with chained methods, that can be invoked like this: - o.fn1().fn2() - o.fn2().fn3() - o.fn2().and.fn3() + + o.fn3(); // same as o.fn1() + o.fn1().and.fn2() // same as o.fn1().fn2() + o.fn1().and.not.fn2() // options.not is set when fn2 is called -I use it to define the mocks, stubs, and expectations in LzTestKit. +I use this to define the mocks, stubs, and expectations in LzTestKit[http://osteele.com/sources/openlaszlo/lztestkit]. -I've extracted a couple of files, from LzTestKit, into the 'examples' +I've extracted a couple of files, from LzTestKit, into the examples[http://osteele.com/sources/javascript/fluently/examples/] directory. These don't run on their own, but at least they show the code in use. +You can also see a range of examples by viewing the sources to the specs[http://osteele.com/sources/javascript/fluently/specs/]. + += Download + +Get it here: {download-location}. + = License Fluently is licensed under the MIT License. -This package includes a distribution of jsspec, which is licensed under the GLPL. +This package includes a distribution of jsspec, which is licensed under the LGPL. README @@ -1,11 +1,10 @@ require 'rake/packagetask' -require 'rake/packagetask.rb' PROJECT_NAME = "fluently" RELEASE_VERSION = open('VERSION').read.chomp PACKAGE_NAME = "#{PROJECT_NAME}-#{RELEASE_VERSION}.tgz" -IGNORE_FILES = Dir['**/#*#'] + Dir['**/.#*'] + Dir['build/**'] + Dir['working/**'] + %w{build working agenda.txt} +IGNORE_FILES = Dir['**/#*#'] + Dir['**/.#*'] + Dir['build/**'] + Dir['working/**'] + Dir['pkg/*'] + %w{build working agenda.txt} PACKAGE_FILES = Dir['**/*'] - Dir['*.tgz'] - IGNORE_FILES task :docs => 'build/index.html' @@ -17,8 +16,9 @@ end task :publish => [:package, :docs] do target = "osteele.com:osteele.com/sources/javascript/fluently" - sh "rsync README #{PACKAGE_NAME} #{target}" + sh "rsync pkg/* #{target}" sh "rsync build/index.html #{target}/index.html" + sh "rsync -a #{PACKAGE_FILES.join(' ')} #{target}" end task :clean do Rakefile @@ -1,7 +1,9 @@ * Next +- accept multiple modifiers - more test cases: modifiers, aliases; look at every code path - examples * API +- define empty alias with define.alias - default modifier table, retrieved via this - define a set of objects agenda.txt @@ -7,18 +7,19 @@ <script type="text/javascript" src="../jsspec/diff_match_patch.js"></script> <script type="text/javascript" src="../jsspec/JSSpec.js"></script> <script type="text/javascript" src="../fluently.js"></script> -<script type="text/javascript">// <![CDATA[ +<script type="text/javascript">//<![CDATA[ describe('Definitions', { - 'should call the right function': function() { - var chain = Fluently.make(function(define) { + 'should call the right function': function() { + var chain = Fluently.make(function(define) { define('a', function() {return 1}); define('b', function() {return 2}); }); value_of(chain.a()).should_be(1); - }, - 'should chain': function() { + value_of(chain.b()).should_be(2); + }, + 'should chain': function() { var trace; - var chain = Fluently.make(function(define) { + var chain = Fluently.make(function(define) { define('reset', function() {trace = ''}); define('a', function() {trace += 'a'}); define('b', function() {trace += 'b'}); @@ -26,9 +27,61 @@ describe('Definitions', { }); value_of(chain.reset().a().trace()).should_be('a'); value_of(chain.reset().a().b().trace()).should_be('ab'); - } + }, + 'should recognize aliases': function() { + var chain = Fluently.make(function(define) { + define('a', function() {return 1}); + define('b', function() {return 2}); + define.empty('self'); + define.alias('alias_a', 'a'); + define.alias('alias_b', 'b'); + }); + value_of(chain.self.a()).should_be(1); + value_of(chain.alias_a()).should_be(1); + value_of(chain.alias_b()).should_be(2); + value_of(chain.self.alias_a()).should_be(1); + }, + 'should apply modifiers': function() { + var trace; + var options = {}; + options.reset = function() { + for (var name in options) + if (name != 'reset') + delete options[name]; + } + function t(methodName) { + var optionNames = []; + for (var name in options) + name == 'reset' || optionNames.push(name); + optionNames.sort(); + spans = [methodName, '(']; + for (var ix = 0; ix < optionNames.length; ix++) { + var name = optionNames[ix]; + ix && spans.push(','); + spans.push(name); + options[name] == true || spans.push(':', options[name]); + } + spans.push(')'); + trace += spans.join(''); + } + var chain = Fluently.make(function(define) { + define.modifier.dictionary(options); + define.modifier('o1'); + define.modifier('o2'); + define('reset', function() {trace = ''; options.reset()}); + define('a', function() {t('a')}); + define('b', function() {t('b')}); + define('trace', function() {return trace}); + }); + value_of(chain.reset().a().trace()).should_be('a()'); + value_of(chain.reset().a().b().trace()).should_be('a()b()'); + value_of(chain.reset().o1.a().trace()).should_be('a(o1)'); + value_of(chain.reset().o2.a().trace()).should_be('a(o2)'); + // pending: + // value_of(chain.reset().o1.o2.a().trace()).should_be('a(o1)'); + } }) -// ]]></script> +//]]></script> </head> <body><div style="display:none;"><p>A</p><p>B</p></div></body> -</html> \ No newline at end of file +</html> specs/fluently-spec.html c5f36a9563b4b87e1d884b95e51a05d59e250ff6 Oliver Steele steele@osteele.com http://github.com/osteele/fluently/commit/4c66866f89d12abdf743ef24494ac64ca3a69c5e 4c66866f89d12abdf743ef24494ac64ca3a69c5e 2008-01-23T14:42:23-08:00 2008-01-23T14:42:23-08:00 more specs, docs c33963af8485e4656dcffcd64aea1beac0947472 Oliver Steele steele@osteele.com