diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) 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. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 1985 Alois Cochard + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/git-sanity.cabal b/git-sanity.cabal new file mode 100644 --- /dev/null +++ b/git-sanity.cabal @@ -0,0 +1,44 @@ +-- Initial git-sanity.cabal generated by cabal init. For further +-- documentation, see http://haskell.org/cabal/users-guide/ + +name: git-sanity +version: 0.0.1 +synopsis: A sanity checker for your git history. +description: + This tool allow you sanity check the history of local git repository. + . + A 'sane' history is one where there is no interleaved merged. +homepage: github.com/aloiscochard/git-sanity +license: Apache-2.0 +license-file: LICENSE +author: Alois Cochard +maintainer: alois.cochard@gmail.com +category: Development +build-type: Simple +cabal-version: >=1.10 + +library + default-language: Haskell2010 + hs-source-dirs: src + ghc-options: -fwarn-incomplete-patterns + exposed-modules: + Git.Sanity + Git.Sanity.Internal + build-depends: + base >=4.6 && <4.8 + , bytestring + , machines + , machines-io + , machines-process + , process + , safe + , transformers + +executable git-sanity + default-language: Haskell2010 + main-is: src/Main.hs + ghc-options: -threaded -fwarn-incomplete-patterns + build-depends: + base + , Cabal + , git-sanity diff --git a/src/Git/Sanity.hs b/src/Git/Sanity.hs new file mode 100644 --- /dev/null +++ b/src/Git/Sanity.hs @@ -0,0 +1,45 @@ +{-# LANGUAGE Rank2Types #-} +module Git.Sanity where + +import Control.Applicative +import Control.Monad +import Control.Monad.IO.Class +import Data.ByteString.Char8 (ByteString) +import Data.Machine +import Safe +import System.Exit (ExitCode) +import System.IO.Machine (IODataMode(..), byLine) +import System.Process (CreateProcess(..), StdStream(CreatePipe), shell) +import System.Process.Machine (callProcessMachines, mStdOut) + +import qualified Data.ByteString.Char8 as BS + +import Git.Sanity.Internal + +type Range = String +type Line = ByteString +type Hash = ByteString + +analyze :: Range -> IO (ExitCode, Int) +analyze range = do + res <- callProcessMachines byLine (gitLogParents range) (mStdOut $ report <~ filterInsane <~ slide <~ parseHashes) + return $ length <$> res + +gitLogParents :: Range -> CreateProcess +gitLogParents range = (shell $ concat ["git log ", range, " --parents | cat"]) { std_out = CreatePipe } + +-- | Parse `git log --parents` command output and return a stream of commit parents hashes +parseHashes :: Process Line [Hash] +parseHashes = fmap parse $ filtered (BS.isPrefixOf prefix) where + parse = (BS.split ' ') . BS.drop (BS.length prefix) + prefix = BS.pack "commit " + +filterInsane :: Process ([Hash], [Hash]) (Hash) +filterInsane = repeatedly f where + f = await >>= \(xs, ys) -> if last xs == head ys then f else yield $ head xs + +report :: ProcessT IO Hash () +report = repeatedly $ do + x <- await + liftIO . putStrLn $ BS.unpack x + yield () diff --git a/src/Git/Sanity/Internal.hs b/src/Git/Sanity/Internal.hs new file mode 100644 --- /dev/null +++ b/src/Git/Sanity/Internal.hs @@ -0,0 +1,11 @@ +module Git.Sanity.Internal where + +import Data.Machine + +-- TODO Contribute to machine? +slide :: Process a (a, a) +slide = f Nothing where + f Nothing = await (\x -> f $ Just x) + f (Just x) = await (\y -> machine $ Yield (x, y) $ f $ Just y) + await f = machine $ Await f Refl stopped + machine = MachineT . return diff --git a/src/Main.hs b/src/Main.hs new file mode 100644 --- /dev/null +++ b/src/Main.hs @@ -0,0 +1,47 @@ +module Main where + +import Distribution.Text (display) +import Paths_git_sanity (version) +import System.Environment +import System.Exit + +import Git.Sanity (analyze) + +name :: String +name = "git-sanity" + +help :: IO () +help = putStrLn $ + unlines [ concat ["Usage: ", name, " [check []]" ] + , " [--help]" + , " [--version]" + , "" + , " Check only commits in the specified revision range." + , "" + , "When no is specified, it defaults to HEAD (i.e. the whole history leading to the current commit)." + , "" + , "In order to integrate nicely as a pre-push githooks (http://git-scm.com/docs/githooks.html)," + , "a of 'origin/$branch..HEAD'[1] can be used to specifies all the commits reachable from the current commit (i.e. HEAD), but not from origin." + , "" + , "[1] Where 'branch' is a variable defined as 'branch=$(git symbolic-ref --short HEAD)'" ] + +main :: IO () +main = do + args <- getArgs + run args where + check range = do + (exitCode, total) <- analyze range + if total == 0 then + exitWith exitCode + else do + putStrLn "" + putStrLn $ concat [name, ": ", show total, " insane commit(s)."] + exitFailure + run ["check", range] = check range + run ["check"] = check "HEAD" + run ["--version"] = putStrLn $ concat [name, ": ", display version] + run ["--help"] = help + run [] = help + run (x:_) = do + putStrLn $ concat [name, ": '", x,"' is not a valid command. See '", name, " --help'."] + exitWith (ExitFailure 1)