Merge pull request #11 from diffr/issue-10

closes #10: Setup HTF and QuickCheck.
closes #12: Enable Travis CI.

Author: w-martin

.travis.yml

@@ -0,0 +1,3 @@
+language: haskell
+notifications:
+  email: false

AUTHORS

@@ -1,4 +1,3 @@
 Amaury Couste <[email protected]>
 Jakub Kozlowski <[email protected]>
 William Martin <[email protected]>
-

INSTALL.md

@@ -1,8 +1,17 @@
 Installation Instructions
 =========================
-This program is written in Haskell and built using cabal.  
+
+This program is written in Haskell and built using (cabal)[http://www.haskell.org/cabal/].  
+
+It is suggested that (cabal-dev)[http://hackage.haskell.org/package/cabal-dev] be used as
+it provides a sandboxed, per-project dependency management, which leads to less issues with
+conflicting library versions. 
+
 To build, you will need:
 * haskell-platform
+* cabal (or cabal-dev)
+
+If you're on a mac, check out (homebrew)[http://mxcl.github.io/homebrew/].
 
 #### Building
 
@@ -19,7 +28,7 @@ Optionally:
 #### Testing
 
 1. Run "cabal clean".
-2. Run "cabal configure".
+2. Run "cabal configure --enable-tests".
 3. Run "cabal build" to compile the sources to dist/.
 4. Run "cabal test" to run the tests.
 

README.md

@@ -1,5 +1,7 @@
 diffr-h
 =======
+[![Build Status](https://travis-ci.org/diffr/diffr-h.png)](https://travis-ci.org/diffr/diffr-h)
+
 An intelligent diff/patch tool that knows how to copy and move, has an 'r' at the end of its name and is written in Haskell.
 
 * See AUTHORS for the details on who contributed to this awesome project.

diffr.cabal

@@ -1,18 +1,31 @@
-name:               diffr
-version:            0.1
-description:        Intelligent diff/patch tool that knows how to copy and move, has an 'r' at the end of its name.
-license:            GPL-3
-license-file:       LICENCE
-author:             Amaury Couste, Jakub Kozlowski, William Martin
-maintainer:
-build-Type:         Simple
-cabal-Version:      >=1.2
+name:           diffr
+version:        0.1
+description:    Intelligent diff/patch tool that knows how to copy and move, has an 'r' at the end of its name.
+license:        GPL-3
+license-file:   LICENCE
+author:         Amaury Couste, Jakub Kozlowski, William Martin
+maintainer:     
+build-Type:     Simple
+cabal-Version:  >=1.2
 
 executable diffr
-  hs-source-dirs:   src
-  main-is:          Diffr/Main.hs
-  build-Depends:    
+  hs-source-dirs:  src
+  main-is:         Diffr/Main.hs
+  build-Depends:   
                     base >= 4,
                     cmdargs > 0.10
-  ghc-options:      -Wall
-  other-modules:    Diffr.Util
+  ghc-options:     -Wall
+  other-modules:   Diffr.Util
+
+test-suite TestSuite
+  type:            exitcode-stdio-1.0
+  main-is:         TestSuite.hs
+  ghc-options:     -Wall -rtsopts
+  build-depends:   base >= 4, HTF > 0.9
+  other-modules:   
+                  Diffr.Util,
+                  Diffr.UtilTest
+  hs-source-dirs:  
+                  test,
+                  src
+

src/Diffr/Main.hs

@@ -1,4 +1,4 @@
-{-# LANGUAGE DeriveDataTypeable, RecordWildCards #-}
+{-# LANGUAGE DeriveDataTypeable #-}
 {- |
  Module      :  Main
  Description :  Main entry point for Diffr.
@@ -21,9 +21,9 @@
 
 module Main(main) where
 
-import System.Environment ( getArgs, withArgs )
-import qualified System.Console.CmdArgs as CM 
-import qualified Diffr.Util as DU
+import qualified Diffr.Util             as DU
+import qualified System.Console.CmdArgs as CM
+import           System.Environment     (getArgs, withArgs)
 
 main :: IO ()
 main = do

src/Diffr/Util.hs

@@ -20,13 +20,13 @@
 -}
 module Diffr.Util (
       DConfig(..)
-    , diffrModes 
+    , diffrModes
 ) where
 
-import System.Console.CmdArgs
+import           System.Console.CmdArgs
 
 {-| Static values -}
-_PROGRAM_NAME, _PROGRAM_VERSION, 
+_PROGRAM_NAME, _PROGRAM_VERSION,
  _PROGRAM_INFO, _PROGRAM_ABOUT, _COPYRIGHT :: String
 _PROGRAM_NAME = "diffr"
 _PROGRAM_VERSION = "0.1"
@@ -43,48 +43,48 @@ _COPYRIGHT = "(C) diffr 2013"
 {-| Configuration for running diffr's commands -}
 data DConfig =
 
-    -- | Configuration for running diff command 
-    Diff  { -- | Path to the 'base' file we will diff against 
+    -- | Configuration for running diff command
+    Diff  { -- | Path to the 'base' file we will diff against
             baseFile     :: FilePath
-  
-            -- | Path to the 'new' file we will compare to 'base' file 
-          , newFile    :: FilePath  
-         
+
+            -- | Path to the 'new' file we will compare to 'base' file
+          , newFile    :: FilePath
+
             -- | Path to the output file where to write the diff file
           , dOutFile    :: Maybe FilePath
           }
-        
-    -- | Configuration for running patch command       
+
+    -- | Configuration for running patch command
   | Patch { -- | Path to the 'original' file we will apply patch to
             originalFile :: FilePath
-          
+
             -- | Path to the 'patch' file we will apply to 'originalFile'
           , patchFile  :: FilePath
-          
+
             -- | Path to the output file where to write the patched file
           , pOutFile    :: Maybe FilePath
-          } deriving (Show, Data, Typeable)
+          } deriving (Eq, Show, Data, Typeable)
 
 {-| Annotate the 'Diff' configuration -}
 diff :: DConfig
 diff = Diff
-    { baseFile  = def &= argPos 0 
-                      &= typ "BASEFILE"    
-    , newFile   = def &= argPos 1 
-                      &= typ "NEWFILE"     
-    , dOutFile  = def &= help "path to the output file"                                      
+    { baseFile  = def &= argPos 0
+                      &= typ "BASEFILE"
+    , newFile   = def &= argPos 1
+                      &= typ "NEWFILE"
+    , dOutFile  = def &= help "path to the output file"
                       &= name "output-file" &= typFile
     }
-                
+
 {-| Annotate the 'Patch' configuration -}
 patch :: DConfig
 patch = Patch
-    { originalFile  = def &= argPos 0 
-                          &= typ "ORIGINALFILE"              
+    { originalFile  = def &= argPos 0
+                          &= typ "ORIGINALFILE"
     , patchFile     = def &= argPos 1
-                          &= typ "PATCHFILE"        
-    , pOutFile      = def &= help "Path to the output file where to write the patched file"  
-                          &= name "output-file"   
+                          &= typ "PATCHFILE"
+    , pOutFile      = def &= help "Path to the output file where to write the patched file"
+                          &= name "output-file"
                           &= typFile
     }
 
@@ -96,4 +96,4 @@ diffrModes = cmdArgsMode $ modes [diff, patch]
     &= help _PROGRAM_ABOUT
     &= helpArg [explicit, name "help", name "h"]
     &= program _PROGRAM_NAME
-             
+

test/Diffr/UtilTest.hs

@@ -0,0 +1,39 @@
+{-# OPTIONS_GHC -F -pgmF htfpp #-}
+{- |
+ Module      :  UtilTest
+ Description :  Tests 'Diffr.Util'.
+ Since       :  0.1
+ Authors     :  William Martin, Jakub Kozlowski
+ License     :  This file is part of diffr-h.
+
+ diffr-h is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ diffr-h is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+ You should have received a copy of the GNU General Public License
+ along with diffr-h.  If not, see <http://www.gnu.org/licenses/>.
+-}
+module Diffr.UtilTest where
+
+import qualified Diffr.Util                 as DU
+import           Test.Framework
+import           Test.Framework.TestManager
+
+-- | Example QuickCheck test
+prop_config :: FilePath -> FilePath -> FilePath -> Bool
+prop_config base new out =  config == config
+    where config = DU.Diff { DU.baseFile = base, DU.newFile = new, DU.dOutFile = Just out}
+
+-- | Test fixture
+defaultConfig :: DU.DConfig
+defaultConfig = DU.Diff { DU.baseFile = "original.txt", DU.newFile = "original-1.txt", DU.dOutFile = Nothing}
+
+-- | Example assertion test
+test_oddSquareSum :: Assertion
+test_oddSquareSum = do assertEqual defaultConfig defaultConfig
+                       assertEqual True True

test/TestSuite.hs

@@ -0,0 +1,14 @@
+{-# OPTIONS_GHC -F -pgmF htfpp #-}
+module Main where
+
+
+import Test.Framework
+
+{-| 
+ Simply import the test classes,
+ in order for them to be run.
+-} 
+import {-@ HTF_TESTS @-} Diffr.UtilTest
+
+main :: IO()
+main = htfMain htf_importedTests