From 35e89cefb1c9dda55b14f390a861279341e148f7 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Sat, 22 Mar 2014 16:17:50 +0000 Subject: [PATCH] Added the source file, which is what actually matters --- LICENSE | 221 +++++++++++++++++++++++-------------------- README.md | 18 +++- doc/intro.md | 3 + project.clj | 6 ++ src/vending/core.clj | 119 +++++++++++++++++++++++ 5 files changed, 259 insertions(+), 108 deletions(-) create mode 100644 doc/intro.md create mode 100644 project.clj create mode 100644 src/vending/core.clj diff --git a/LICENSE b/LICENSE index 5032843..786edf6 100644 --- a/LICENSE +++ b/LICENSE @@ -1,5 +1,3 @@ -Eclipse Public License - v 1.0 - THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. @@ -8,19 +6,22 @@ CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. "Contribution" means: -a) in the case of the initial Contributor, the initial code and documentation - distributed under this Agreement, and -b) in the case of each subsequent Contributor: - i) changes to the Program, and - ii) additions to the Program; +a) in the case of the initial Contributor, the initial code and +documentation distributed under this Agreement, and - where such changes and/or additions to the Program originate from and are - distributed by that particular Contributor. A Contribution 'originates' - from a Contributor if it was added to the Program by such Contributor - itself or anyone acting on such Contributor's behalf. Contributions do not - include additions to the Program which: (i) are separate modules of - software distributed in conjunction with the Program under their own - license agreement, and (ii) are not derivative works of the Program. +b) in the case of each subsequent Contributor: + +i) changes to the Program, and + +ii) additions to the Program; + +where such changes and/or additions to the Program originate from and are +distributed by that particular Contributor. A Contribution 'originates' from +a Contributor if it was added to the Program by such Contributor itself or +anyone acting on such Contributor's behalf. Contributions do not include +additions to the Program which: (i) are separate modules of software +distributed in conjunction with the Program under their own license +agreement, and (ii) are not derivative works of the Program. "Contributor" means any person or entity that distributes the Program. @@ -35,91 +36,100 @@ Agreement. including all Contributors. 2. GRANT OF RIGHTS - a) Subject to the terms of this Agreement, each Contributor hereby grants - Recipient a non-exclusive, worldwide, royalty-free copyright license to - reproduce, prepare derivative works of, publicly display, publicly - perform, distribute and sublicense the Contribution of such Contributor, - if any, and such derivative works, in source code and object code form. - b) Subject to the terms of this Agreement, each Contributor hereby grants - Recipient a non-exclusive, worldwide, royalty-free patent license under - Licensed Patents to make, use, sell, offer to sell, import and otherwise - transfer the Contribution of such Contributor, if any, in source code and - object code form. This patent license shall apply to the combination of - the Contribution and the Program if, at the time the Contribution is - added by the Contributor, such addition of the Contribution causes such - combination to be covered by the Licensed Patents. The patent license - shall not apply to any other combinations which include the Contribution. - No hardware per se is licensed hereunder. - c) Recipient understands that although each Contributor grants the licenses - to its Contributions set forth herein, no assurances are provided by any - Contributor that the Program does not infringe the patent or other - intellectual property rights of any other entity. Each Contributor - disclaims any liability to Recipient for claims brought by any other - entity based on infringement of intellectual property rights or - otherwise. As a condition to exercising the rights and licenses granted - hereunder, each Recipient hereby assumes sole responsibility to secure - any other intellectual property rights needed, if any. For example, if a - third party patent license is required to allow Recipient to distribute - the Program, it is Recipient's responsibility to acquire that license - before distributing the Program. - d) Each Contributor represents that to its knowledge it has sufficient - copyright rights in its Contribution, if any, to grant the copyright - license set forth in this Agreement. + +a) Subject to the terms of this Agreement, each Contributor hereby grants +Recipient a non-exclusive, worldwide, royalty-free copyright license to +reproduce, prepare derivative works of, publicly display, publicly perform, +distribute and sublicense the Contribution of such Contributor, if any, and +such derivative works, in source code and object code form. + +b) Subject to the terms of this Agreement, each Contributor hereby grants +Recipient a non-exclusive, worldwide, royalty-free patent license under +Licensed Patents to make, use, sell, offer to sell, import and otherwise +transfer the Contribution of such Contributor, if any, in source code and +object code form. This patent license shall apply to the combination of the +Contribution and the Program if, at the time the Contribution is added by the +Contributor, such addition of the Contribution causes such combination to be +covered by the Licensed Patents. The patent license shall not apply to any +other combinations which include the Contribution. No hardware per se is +licensed hereunder. + +c) Recipient understands that although each Contributor grants the licenses +to its Contributions set forth herein, no assurances are provided by any +Contributor that the Program does not infringe the patent or other +intellectual property rights of any other entity. Each Contributor disclaims +any liability to Recipient for claims brought by any other entity based on +infringement of intellectual property rights or otherwise. As a condition to +exercising the rights and licenses granted hereunder, each Recipient hereby +assumes sole responsibility to secure any other intellectual property rights +needed, if any. For example, if a third party patent license is required to +allow Recipient to distribute the Program, it is Recipient's responsibility +to acquire that license before distributing the Program. + +d) Each Contributor represents that to its knowledge it has sufficient +copyright rights in its Contribution, if any, to grant the copyright license +set forth in this Agreement. 3. REQUIREMENTS A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that: - a) it complies with the terms and conditions of this Agreement; and - b) its license agreement: - i) effectively disclaims on behalf of all Contributors all warranties - and conditions, express and implied, including warranties or - conditions of title and non-infringement, and implied warranties or - conditions of merchantability and fitness for a particular purpose; - ii) effectively excludes on behalf of all Contributors all liability for - damages, including direct, indirect, special, incidental and - consequential damages, such as lost profits; - iii) states that any provisions which differ from this Agreement are - offered by that Contributor alone and not by any other party; and - iv) states that source code for the Program is available from such - Contributor, and informs licensees how to obtain it in a reasonable - manner on or through a medium customarily used for software exchange. +a) it complies with the terms and conditions of this Agreement; and + +b) its license agreement: + +i) effectively disclaims on behalf of all Contributors all warranties and +conditions, express and implied, including warranties or conditions of title +and non-infringement, and implied warranties or conditions of merchantability +and fitness for a particular purpose; + +ii) effectively excludes on behalf of all Contributors all liability for +damages, including direct, indirect, special, incidental and consequential +damages, such as lost profits; + +iii) states that any provisions which differ from this Agreement are offered +by that Contributor alone and not by any other party; and + +iv) states that source code for the Program is available from such +Contributor, and informs licensees how to obtain it in a reasonable manner on +or through a medium customarily used for software exchange. When the Program is made available in source code form: - a) it must be made available under this Agreement; and - b) a copy of this Agreement must be included with each copy of the Program. - Contributors may not remove or alter any copyright notices contained - within the Program. +a) it must be made available under this Agreement; and + +b) a copy of this Agreement must be included with each copy of the Program. + +Contributors may not remove or alter any copyright notices contained within +the Program. Each Contributor must identify itself as the originator of its Contribution, -if -any, in a manner that reasonably allows subsequent Recipients to identify the -originator of the Contribution. +if any, in a manner that reasonably allows subsequent Recipients to identify +the originator of the Contribution. 4. COMMERCIAL DISTRIBUTION Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who -includes the Program in a commercial product offering should do so in a manner -which does not create potential liability for other Contributors. Therefore, -if a Contributor includes the Program in a commercial product offering, such -Contributor ("Commercial Contributor") hereby agrees to defend and indemnify -every other Contributor ("Indemnified Contributor") against any losses, -damages and costs (collectively "Losses") arising from claims, lawsuits and -other legal actions brought by a third party against the Indemnified -Contributor to the extent caused by the acts or omissions of such Commercial -Contributor in connection with its distribution of the Program in a commercial -product offering. The obligations in this section do not apply to any claims -or Losses relating to any actual or alleged intellectual property -infringement. In order to qualify, an Indemnified Contributor must: +includes the Program in a commercial product offering should do so in a +manner which does not create potential liability for other Contributors. +Therefore, if a Contributor includes the Program in a commercial product +offering, such Contributor ("Commercial Contributor") hereby agrees to defend +and indemnify every other Contributor ("Indemnified Contributor") against any +losses, damages and costs (collectively "Losses") arising from claims, +lawsuits and other legal actions brought by a third party against the +Indemnified Contributor to the extent caused by the acts or omissions of such +Commercial Contributor in connection with its distribution of the Program in +a commercial product offering. The obligations in this section do not apply +to any claims or Losses relating to any actual or alleged intellectual +property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and -b) allow the Commercial Contributor to control, and cooperate with the +b) allow the Commercial Contributor tocontrol, and cooperate with the Commercial Contributor in, the defense and any related settlement -negotiations. The Indemnified Contributor may participate in any such claim at -its own expense. +negotiations. The Indemnified Contributor may participate in any such claim +at its own expense. For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If @@ -133,16 +143,16 @@ Commercial Contributor must pay those damages. 5. NO WARRANTY -EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR -IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, -NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each -Recipient is solely responsible for determining the appropriateness of using -and distributing the Program and assumes all risks associated with its -exercise of rights under this Agreement , including but not limited to the -risks and costs of program errors, compliance with applicable laws, damage to -or loss of data, programs or equipment, and unavailability or interruption of -operations. +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON +AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER +EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR +CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A +PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the +appropriateness of using and distributing the Program and assumes all risks +associated with its exercise of rights under this Agreement , including but +not limited to the risks and costs of program errors, compliance with +applicable laws, damage to or loss of data, programs or equipment, and +unavailability or interruption of operations. 6. DISCLAIMER OF LIABILITY @@ -170,13 +180,13 @@ infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed. All Recipient's rights under this Agreement shall terminate if it fails to -comply with any of the material terms or conditions of this Agreement and does -not cure such failure in a reasonable period of time after becoming aware of -such noncompliance. If all Recipient's rights under this Agreement terminate, -Recipient agrees to cease use and distribution of the Program as soon as -reasonably practicable. However, Recipient's obligations under this Agreement -and any licenses granted by Recipient relating to the Program shall continue -and survive. +comply with any of the material terms or conditions of this Agreement and +does not cure such failure in a reasonable period of time after becoming +aware of such noncompliance. If all Recipient's rights under this Agreement +terminate, Recipient agrees to cease use and distribution of the Program as +soon as reasonably practicable. However, Recipient's obligations under this +Agreement and any licenses granted by Recipient relating to the Program shall +continue and survive. Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be @@ -188,16 +198,17 @@ Eclipse Foundation may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the -Agreement under which it was received. In addition, after a new version of the -Agreement is published, Contributor may elect to distribute the Program +Agreement under which it was received. In addition, after a new version of +the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or -licenses to the intellectual property of any Contributor under this Agreement, -whether expressly, by implication, estoppel or otherwise. All rights in the -Program not expressly granted under this Agreement are reserved. +licenses to the intellectual property of any Contributor under this +Agreement, whether expressly, by implication, estoppel or otherwise. All +rights in the Program not expressly granted under this Agreement are +reserved. -This Agreement is governed by the laws of the State of New York and the +This Agreement is governed by the laws of the State of Washington and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year -after the cause of action arose. Each party waives its rights to a jury trial in -any resulting litigation. \ No newline at end of file +after the cause of action arose. Each party waives its rights to a jury trial +in any resulting litigation. diff --git a/README.md b/README.md index d0b7a8e..3754860 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,16 @@ -vending -======= +# vending -Vending machine code kata, in Clojure. NOT an example of how to do it! +A Clojure implementation of the Vending Machine kata, see http://code.joejag.com/coding-dojo-vending-machine/ + +NOTE! I am LEARNING. This is not an example of how to do it. + +## Usage + +FIXME + +## License + +Copyright © 2014 FIXME + +Distributed under the Eclipse Public License either version 1.0 or (at +your option) any later version. diff --git a/doc/intro.md b/doc/intro.md new file mode 100644 index 0000000..b86a312 --- /dev/null +++ b/doc/intro.md @@ -0,0 +1,3 @@ +# Introduction to vending + +TODO: write [great documentation](http://jacobian.org/writing/great-documentation/what-to-write/) diff --git a/project.clj b/project.clj new file mode 100644 index 0000000..858e97f --- /dev/null +++ b/project.clj @@ -0,0 +1,6 @@ +(defproject vending "0.1.0-SNAPSHOT" + :description "FIXME: write description" + :url "http://example.com/FIXME" + :license {:name "Eclipse Public License" + :url "http://www.eclipse.org/legal/epl-v10.html"} + :dependencies [[org.clojure/clojure "1.5.1"]]) diff --git a/src/vending/core.clj b/src/vending/core.clj new file mode 100644 index 0000000..95b17b0 --- /dev/null +++ b/src/vending/core.clj @@ -0,0 +1,119 @@ +(ns vending.core) + +(defn foo + "I don't do a whole lot." + [x] + (println x "Hello, World!")) + + + +(defn make-default-machine [] { :stock {:apples 5 :oranges 5 :lemons 5} + :coins {:dollars 1 :quarters 4 :dimes 4 :nickels 4} + :tendered nil + :last-message "" + :change nil + :output nil} ) + +(def coin-values {:dollar 1 :quarter 0.25 :dime 0.10 :nickel 0.05}) + +(def item-prices {:apples 0.65 :oranges 1 :lemons 1.5}) + +(defn coin-value [coin] + (coin-values coin)) + +(defn coins-value [coins] + (apply + (map coin-value coins))) + +(defn coin-return [machine] + (assoc (dissoc machine :tendered) :change (:tendered machine))) + +(defn add-coin [machine coin] + (assoc (dissoc machine :tendered) :tendered (cons coin (:tendered machine)))) + +(defn add-coins [machine coins] + (cond (empty? coins) machine + true (add-coins (add-coin machine (first coins)) (rest coins)))) + +(defn magic-inc [maybenum] + (cond (nil? maybenum) 1 + true (inc maybenum))) + +(defn sum-coin [coin sums] + (cond + (= coin :dollar) (update-in sums [:dollar] magic-inc) + (= coin :quarter) (update-in sums [:quarter] magic-inc) + (= coin :dime) (update-in sums [:dime] magic-inc) + (= coin :nickel) (update-in sums [:nickel] magic-inc))) + +(defn sum-coins + "Returns a map {:dollars :quarters :dimes :nickels}" + ([coins] + (sum-coins coins {})) + ([coins sums] + (cond (empty? coins) sums + true (sum-coins (rest coins) (sum-coin (first coins) sums))))) + + + +(defn subtract-denomination [list position] + (cond (= (count list) position)(cons (- (first list) 1) (rest list)) + true (cons (first list) (subtract-denomination (rest list) position)))) + +(defn subtract-nickle [list] + (subtract-denomination list 1)) + +(defn subtract-dime [list] + (subtract-denomination list 2)) + +(defn subtract-quarter [list] + (subtract-denomination list 3)) + +(defn subtract-dollar [list] + (subtract-denomination list 4)) + +(defn in-make-change [amount dollars quarters dimes nickels] + "Return a tuple (dollars quarters nickels dimes) which indicates the number remaining + after making change, or nil if not possible" + (cond + (= amount 0) (list dollars quarters dimes nickels) + (and (>= amount (:dollar coin-values)) (> dollars 0)) + (in-make-change (- amount (:dollar coin-values)) (- dollars 1) quarters dimes nickels) + (and (>= amount (:quarter coin-values)) (> quarters 0)) + (in-make-change (- amount (:quarter coin-values)) dollars (- quarters 1) dimes nickels) + (and (>= amount (:dime coin-values)) (> dimes 0)) + (in-make-change (- amount (:dime coin-values)) dollars quarters (- dimes 1) nickels) + (and (>= amount (:nickel coin-values)) (> nickels 0)) + (in-make-change (- amount (:nickel coin-values)) dollars quarters dimes (- nickels 1)))) + +(defn make-change [amount dollars quarters dimes nickels] + (map #(- %1 %2) (list dollars quarters dimes nickels) + (in-make-change amount dollars quarters dimes nickels) + )) + +(defn make-change-machine [machine change] + machine) + +(defn remove-from-stock [machine item] + machine) + +(defn deliver-item [machine item change] + (make-change-machine + (remove-from-stock + (assoc (dissoc machine :output) :output (cons item (:output machine))) + item) + change)) + + +(defn get-item [machine item] + (let [item-price (item item-prices) + tend (sum-coins (:tendered machine)) + change (make-change item-price (:dollar tend) (:quarter tend) (:dime tend) (:nickel tend))] + (cond (<= 0 (item (:stock machine))) (coin-return machine) + (<= (coins-value (:tendered machine)) item-price) (coin-return machine) + (empty? change) (coin-return) + true (deliver-item machine item change)))) + +(defn get-apple [machine] + (get-item machine :apples)) + +